驹家小程序端

index

diy页面--接口路径和首页布局一样，只是多带了个参数page_id

基本信息

Path： /api/index/index2

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ home_pages	object	非必须
├─ id	string	非必须		diy页面id
├─ title	string	非必须		diy页面名称
├─ show_navs	string	非必须		是否展示导航条0--否1--是
├─ is_home_page	string	非必须		是否设置成首页0--否1--是
├─ navs	object []	非必须		导航条列表	item 类型: object
├─ id	string	非必须		导航条id
├─ name	string	非必须		导航条名称
├─ page_id	string	非必须
├─ template_id	string	非必须
├─ template	object	非必须		模板
├─ id	string	非必须		模板id
├─ name	string	非必须		模板名称
├─ data	object []	非必须		模板数据	item 类型: object
├─ id	string	必须		组件id	枚举: search--搜索框,nav--导航图标,banner--轮播图,notice--公告,topic--专题,link--关联链接,rubik--图片广告,video--视频,goods--商品,store--门店,copyright--版权,check-in--签到,user-info--用户信息,user-order--订单入口,map--地图,mp-link--微信公众号,form--自定义表单,image-text--图文详情,coupon--优惠券,timer--倒计时,mch--好店推荐,pintuan--拼团,booking--预约,miaosha--秒杀,bargain--砍价,integral-mall--积分商城,lottery--抽奖,advance--预售,vip-card--超级会员卡,empty--空白块,ad--流量主广告,modal--弹窗广告,quick-nav--快捷导航
├─ data	object	必须		组件数据---具体详情见《diy接口》
├─ color	string	非必须		搜索框颜色 当组件id=search是生效
├─ background	string	非必须		背景色 当组件id=search生效 当组件id=notice生效
├─ radius	number	非必须		边框圆角 当组件id=search时生效
├─ placeholder	string	非必须		提示内容 当组件id=search时生效
├─ textColor	string	非必须		文字颜色 当组件id=search时生效 当组件id=notice时生效
├─ textPosition	string	非必须		提示文字位置 当组件id=search时生效	枚举: left--靠左,center--居中,right--靠右
├─ rows	number	非必须		导航图标每页显示的行数 当组件id=nav时生效
├─ columns	number	非必须		导航图标每行显示的个数 当组件id=nav时生效
├─ scroll	boolean	非必须		是否允许左右滑动 false--不允许|true--允许 当组件id=nav时生效
├─ navs	object []	非必须		导航图标列表 当组件id=nav时生效	item 类型: object
├─ url	string	必须		链接路由
├─ openType	string	必须		链接类型
├─ picUrl	string	必须
├─ text	string	必须
├─ num	string	必须
├─ open_type	string	必须		链接类型
├─ link_url	string	必须		链接路由
├─ name	string	必须		名称
├─ icon_url	string	必须
├─ icon	string	必须		导航图标图片地址
├─ params	object []	必须		链接参数	item 类型: object
├─ key	string	必须		参数key
├─ value	string	必须		参数值
├─ style	number,string	非必须		当组件id=banner时，轮播图样式1--全屏展示|2--卡片形式 当组件id=topic时，专题样式normal--简易模式|list--列表模式
├─ fill	number	非必须		图片填充方式：0--留白|1--填充 当组件id=banner时生效
├─ height	number	非必须		组件高度 当组件id=banner时生效
├─ banners	object []	非必须		轮播图列表	item 类型: object
├─ picUrl	string	非必须		轮播图图片地址
├─ openType	string	非必须		链接类型
├─ url	string	非必须		链接路由
├─ params	object []	非必须		链接参数	item 类型: object
├─ key	string	非必须		参数key
├─ value	string	非必须		参数值
├─ page_url	string	非必须		链接路由
├─ open_type	string	非必须		链接类型
├─ pic_url	string	非必须		轮播图图片地址
├─ name	string	非必须		当组件id=notice时，公告名称
├─ content	string	非必须		当组件id=notice时，公告内容
├─ icon	string	非必须		当组件id=notice时，公告图标
├─ headerUrl	string	非必须		当组件id=notice时，公告弹窗头部图片
├─ btnColor	string	非必须		当组件id=notice时，公告弹窗按钮背景色
├─ btnWidth	number	非必须		当组件id=notice时，公告弹窗按钮宽度
├─ btnHeight	number	非必须		当组件id=notice时，公告弹窗按钮高度
├─ btnRadius	number	非必须		当组件id=notice时，公告弹窗按钮圆角
├─ btnText	string	非必须		当组件id=notice时，公告弹窗文字
├─ btnTextColor	string	非必须		当组件id=notice时，公告弹窗文字颜色
├─ count	number	非必须		当组件id=topic、style=normal时，专题显示数量
├─ logo_1	string	非必须		一行一个专题图标
├─ logo_2	string	非必须		一行两个专题图标
├─ list	object []	非必须		当组件id=topic时，专题列表	item 类型: object
├─ w	number	必须		当组件id=rubik时，图片宽度
├─ h	number	必须		当组件id=rubik时，图片高度
├─ x	number	必须		当组件id=rubik时，图片左边距
├─ y	number	必须		当组件id=rubik时，图片上边距
├─ link	string []	必须		当组件id=rubik时，图片链接	item 类型: string
├─		非必须
├─ width	string	必须		当组件id=rubik时，图片宽度
├─ height	string	必须		当组件id=rubik时，图片高度
├─ left	string	必须		当组件id=rubik时，图片左边距
├─ top	string	必须		当组件id=rubik时，图片上边距
├─ pic_url	string	必须		当组件id=rubik时，图片地址
├─ id	number,string	必须		当组件id=goods时，商品id
├─ goods_warehouse_id	number	必须		当组件id=goods时，商品库id
├─ mch_id	number	必须		当组件id=goods时，商品所属商户id
├─ sign	string	必须		当组件id=goods时，商品所属插件标示
├─ name	string	必须		当组件id=goods时，商品名称
├─ cover_pic	string	必须
├─ original_price	string	必须
├─ unit	string	必须
├─ page_url	string	必须
├─ is_negotiable	number,string	必须
├─ is_level	number,string	必须
├─ level_price	number	必须
├─ price	string	必须
├─ price_content	string	必须
├─ is_sales	string	必须
├─ sales	string	必须
├─ vip_card_appoint	object	必须
├─ discount	null,string	非必须
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ mobile	string	必须
├─ score	number	必须
├─ longitude	string	必须
├─ latitude	string	必须
├─ picUrl	string	必须
├─ goodsNum	string	必须
├─ orderNum	string	必须
├─ goodsList	object []	必须			item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ picUrl	string	必须
├─ price	string	必须
├─ showGoodsNum	number	必须
├─ staticGoods	boolean	必须
├─ goods_num	string	必须
├─ people_num	number	非必须
├─ pintuan_price	string	非必须
├─ start_time	string	必须
├─ end_time	string	必须
├─ goods_id	string	非必须
├─ mall_id	string	非必须
├─ ladder_rules	string	非必须
├─ deposit	string	非必须
├─ swell_deposit	string	非必须
├─ start_prepayment_at	string	非必须
├─ end_prepayment_at	string	非必须
├─ pay_limit	string	非必须
├─ is_delete	string	非必须
├─ attr	object []	非必须			item 类型: object
├─ id	string	非必须
├─ goods_id	string	非必须
├─ sign_id	string	非必须
├─ stock	string	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	string	非必须
├─ pic_url	string	非必须
├─ is_delete	string	非必须
├─ attr	object	非必须
├─ id	string	非必须
├─ deposit	string	非必须
├─ swell_deposit	string	非必须
├─ goods_id	string	非必须
├─ goods_attr_id	string	非必须
├─ is_delete	string	非必须
├─ advance_num	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	null	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ goodsCatRelation	object []	非必须			item 类型: object
├─ id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ cat_id	string	非必须
├─ is_delete	string	非必须
├─ cats	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ parent_id	string	非必须
├─ name	string	非必须
├─ pic_url	string	非必须
├─ sort	string	非必须
├─ big_pic_url	string	非必须
├─ advert_pic	string	非必须
├─ advert_url	string	非必须
├─ status	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_show	string	非必须
├─ mch	string	非必须
├─ cat_show	boolean	非必须
├─ topic_list	object []	非必须			item 类型: object
├─ id	number	必须
├─ title	string	必须
├─ cover_pic	string	必须
├─ read_count	string	必须
├─ layout	number	必须
├─ pic_list	array,null	必须
├─ title	string	非必须
├─ textLeft	number	非必须
├─ link	object	非必须
├─ type	string	非必须
├─ name	string	非必须
├─ open_type	string	非必须
├─ icon	string	非必须
├─ value	string	非必须
├─ id	number	非必须
├─ new_link_url	string	非必须
├─ url	string	非必须
├─ openType	string	非必须
├─ data	object	非必须
├─ type	string	非必须
├─ name	string	非必须
├─ open_type	string	非必须
├─ icon	string	非必须
├─ value	string	非必须
├─ id	number	非必须
├─ new_link_url	string	非必须
├─ picSwitch	boolean	非必须
├─ arrowsSwitch	boolean	非必须
├─ picUrl	string	非必须
├─ picLeft	number	非必须
├─ space	number	非必须
├─ w	number	非必须
├─ h	number	非必须
├─ hotspot	array,null	非必须
├─ pic_url	string	非必须
├─ url	string	非必须
├─ showCat	boolean	非必须
├─ catPosition	string	非必须
├─ catStyle	number	非必须
├─ catList	string []	非必须			item 类型: string
├─		非必须
├─ listStyle	number	非必须
├─ goodsCoverProportion	string	非必须
├─ goodsStyle	number	非必须
├─ showGoodsName	boolean	非必须
├─ showGoodsPrice	boolean	非必须
├─ showBuyBtn	boolean	非必须
├─ buyBtn	string	非必须
├─ buyBtnStyle	number	非必须
├─ buyBtnText	string	非必须
├─ showGoodsTag	boolean	非必须
├─ customizeGoodsTag	boolean	非必须
├─ goodsTagPicUrl	string	非必须
├─ navPicUrl	string	非必须
├─ scorePicUrl	string	非必须
├─ showName	boolean	非必须
├─ showScore	boolean	非必须
├─ showTel	boolean	非必须
├─ text	string	非必须
├─ backgroundColor	string	非必须
├─ backgroundPicUrl	string	非必须
├─ showText	boolean	非必须
├─ award	object	非必须
├─ continue	number	非必须
├─ number	string	非必须
├─ type	string	非必须
├─ location	string	非必须
├─ paddingY	number	非必须
├─ paddingX	number	非必须
├─ marginTop	number	非必须
├─ marginTopColor	string	非必须
├─ latitude	string	非必须
├─ longitude	number	非必须
├─ position	string,number	非必须
├─ inputPadding	number	非必须
├─ marginBottom	number	非必须
├─ type	number	非必须
├─ times	number	非必须
├─ inputBackground	string	非必须
├─ inputBorder	string	非必须
├─ inputLabel	string	非必须
├─ inputTip	string	非必须
├─ inputText	string	非必须
├─ buttonHeight	number	非必须
├─ buttonPadding	number	非必须
├─ buttonMargin	number	非必须
├─ padding	number	非必须
├─ buttonRadius	number	非必须
├─ borderContent	string	非必须
├─ borderBackground	string	非必须
├─ borderBorder	string	非必须
├─ borderText	string	非必须
├─ marginColor	string	非必须
├─ showImg	boolean	非必须
├─ mode	number	非必须
├─ backgroundHeight	number	非必须
├─ backgroundWidth	number	非必须
├─ formDialog	object []	非必须			item 类型: object
├─ key	string	必须
├─ key_name	string	必须
├─ name	string	必须
├─ is_required	number	必须
├─ receiveBg	string	非必须
├─ unclaimedBg	string	非必须
├─ coupon_list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ name	string	必须
├─ type	string	必须
├─ discount	string	必须
├─ discount_limit	null	必须
├─ pic_url	string	必须
├─ desc	string	必须
├─ min_price	string	必须
├─ sub_price	string	必须
├─ total_count	string	必须
├─ sort	string	必须
├─ expire_type	string	必须
├─ expire_day	string	必须
├─ begin_time	string	必须
├─ end_time	string	必须
├─ appoint_type	string	必须
├─ rule	string	必须
├─ is_member	string	必须
├─ is_delete	string	必须
├─ deleted_at	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ is_receive	string	必须
├─ couponCat	string []	必须			item 类型: string
├─		非必须
├─ cat	string []	必须			item 类型: string
├─		非必须
├─ couponGoods	object []	必须			item 类型: object
├─ id	string	必须
├─ coupon_id	string	必须
├─ goods_warehouse_id	string	必须
├─ is_delete	string	必须
├─ goods	object []	必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ name	string	必须
├─ original_price	string	必须
├─ cost_price	string	必须
├─ detail	string	必须
├─ cover_pic	string	必须
├─ pic_url	string	必须
├─ video_url	string	必须
├─ unit	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ page_url	string	必须
├─ startDateTime	string	非必须
├─ endDateTime	string	非必须
├─ showGoods	boolean	非必须
├─ buttonColor	string	非必须
├─ showCoupon	boolean	非必须
├─ couponColor	string	非必须
├─ couponPicUrl	string	非必须
├─ goodsIndex	number	非必须
├─ start_x	number	非必须
├─ buy_bg	string	非必须
├─ renew_bg	string	非必须
├─ buy_big_color	string	非必须
├─ buy_small_color	string	非必须
├─ buy_btn_color	string	非必须
├─ buy_btn_bg_color	string	非必须
├─ buy_big	string	非必须
├─ buy_small	string	非必须
├─ buy_btn_text	string	非必须
├─ renew_text_color	string	非必须
├─ renew_btn_bg_color	string	非必须
├─ renew_text	string	非必须
├─ usePluginConfig	boolean	非必须
├─ top_bottom_padding	number	非必须
├─ id	string	非必须
├─ opened	boolean	非必须
├─ closedPicUrl	string	非必须
├─ openedPicUrl	string	非必须
├─ navStyle	string	非必须
├─ navSwitch	number	非必须
├─ useMallConfig	boolean	非必须
├─ customerService	object	非必须
├─ picUrl	string	非必须
├─ opened	number	非必须
├─ home	object	非必须
├─ opened	number	非必须
├─ picUrl	string	非必须
├─ mApp	object	非必须
├─ opened	number	非必须
├─ small_app_id	string	非必须
├─ small_app_url	string	非必须
├─ small_app_pic	string	非必须
├─ mapNav	object	非必须
├─ opened	number	非必须
├─ picUrl	string	非必须
├─ address	string	非必须
├─ latitude	string	非必须
├─ longitude	string	非必须
├─ tel	object	非必须
├─ opened	number	非必须
├─ picUrl	string	非必须
├─ number	string	非必须
├─ web	object	非必须
├─ opened	number	非必须
├─ picUrl	string	非必须
├─ url	string	非必须
├─ type	string	非必须		页面数据类型	枚举: mall--首页布局,diy--diy页面数据

商城配置

基本信息

Path： /index/config

Method： GET

接口描述：

商城配置

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ mall	object	非必须
├─ name	string	非必须
├─ title_bar	object	非必须
├─ background	string	非必须
├─ color	string	非必须
├─ navbar	object	非必须
├─ bottom_background_color	string	非必须
├─ top_background_color	string	非必须
├─ top_text_color	string	非必须
├─ shadow	boolean	非必须
├─ navs	object []	非必须			item 类型: object
├─ active_color	string	必须
├─ active_icon	string	必须
├─ color	string	必须
├─ text	string	必须
├─ icon	string	必须
├─ url	string	必须
├─ open_type	string	必须
├─ user_center	object	非必须
├─ is_account_status	string	非必须
├─ is_menu_status	string	非必须
├─ is_order_bar_status	string	非必须
├─ menu_style	string	非必须
├─ top_style	string	非必须
├─ top_pic_url	string	非必须
├─ account	object []	非必须			item 类型: object
├─ icon_url	string	必须
├─ name	string	必须
├─ menus	object []	非必须			item 类型: object
├─ icon_url	string	必须
├─ link_url	string	必须
├─ name	string	必须
├─ open_type	string	必须
├─ order_bar	object []	非必须			item 类型: object
├─ icon_url	string	必须
├─ name	string	必须
├─ link_url	string	必须
├─ open_type	string	必须
├─ plugin	object	非必须
├─ demo	object	非必须
├─ app_image	object	非必须
├─ banner_image	string	非必须
├─ aliapp	string []	非必须			item 类型: string
├─		非必须
├─ wxapp	string []	非必须			item 类型: string
├─		非必须
├─ pond	object	非必须
├─ app_image	object	非必须
├─ pond_head	string	非必须
├─ pond_success	string	非必须
├─ pond_empty	string	非必须
├─ scratch	object	非必须
├─ app_image	object	非必须
├─ scratch_bg	string	非必须
├─ scratch_win	string	非必须
├─ copyright	object	非必须
├─ pic_url	string	非必须
├─ description	string	非必须
├─ type	string	非必须
├─ link_url	string	非必须
├─ moblie	string	非必须
├─ mobile	string	非必须
├─ __wxapp_img	object	非必须
├─ mall	object	非必须
├─ close	string	非必须
├─ order	object	非必须
├─ status_bar	string	非必须
├─ balance	string	非必须
├─ huodao	string	非必须
├─ online	string	非必须
├─ share	object	非必须
├─ apply	string	非必须
├─ status	string	非必须
├─ share_setting	object	非必须
├─ level	number	非必须		合伙人等级 0--关闭 1--一级 2--二级 3--三级
├─ is_rebate	number	非必须		合伙人内购是否开启 0--关闭 1--开启
├─ price_type	number	非必须		合伙人佣金类型 1--百分比 2--固定金额
├─ first	number	非必须		一级佣金
├─ second	number	非必须		二级佣金
├─ third	number	非必须		三级佣金
├─ share_condition	number	非必须		成为合伙人条件1--申请 2--无需申请 3--无需审核
├─ condition	number	非必须		成为下线条件 1--首次点击链接 2--首次下单 3--首次付款
├─ auto_share_val	number	非必须		消费满自动成为合伙人
├─ share_goods_status	number	非必须		购买商品成为合伙人0--关闭 1--任意商品 2--指定商品
├─ share_goods_id	number	非必须		购买的商品ID
├─ pay_type	string []	非必须		提现方式	item 类型: string
├─		非必须
├─ cash_max_day	number	非必须		每日提现上限
├─ min_money	number	非必须		最少提现金额
├─ cash_service_charge	number	非必须		提现手续费
├─ agree	string	非必须		申请协议
├─ content	string	非必须		用户须知
├─ pic_url_apply	string	非必须		申请页面图片
├─ pic_url_status	string	非必须		审核页面图片
├─ surplusCash	number	非必须		今日剩余可提现金额
├─ share_setting_custom	object	非必须		合伙人自定义设置（同合伙人--自定义设置）

测试

基本信息

Path： /cart/add

Method： GET

接口描述：
undefined

请求参数

购买框

基本信息

Path： /api/index/purchase

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object []	非必须			item 类型: object
├─ content	string	必须		购买信息
├─ time_str	string	必须		时间信息
├─ avatar	string	必须		头像
├─ page_url	string	必须		跳转路径
├─ sign	string	必须		插件标识
├─ goods_id	number	必须		商品id

首页布局

基本信息

Path： /api/index/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page_id	是	0
longitude	是
latitude	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ home_pages	object	非必须
├─ id	string	非必须		diy页面id
├─ title	string	非必须		diy页面名称
├─ show_navs	string	非必须		是否展示导航条0--否1--是
├─ is_home_page	string	非必须		是否设置成首页0--否1--是
├─ navs	object []	非必须		导航条列表	item 类型: object
├─ id	string	非必须		导航条id
├─ name	string	非必须		导航条名称
├─ page_id	string	非必须
├─ template_id	string	非必须
├─ template	object	非必须		模板
├─ id	string	非必须		模板id
├─ name	string	非必须		模板名称
├─ data	object []	非必须		模板数据	item 类型: object
├─ id	string	必须		组件id	枚举: search--搜索框,nav--导航图标,banner--轮播图,notice--公告,topic--专题,link--关联链接,rubik--图片广告,video--视频,goods--商品,store--门店,copyright--版权,check-in--签到,user-info--用户信息,user-order--订单入口,map--地图,mp-link--微信公众号,form--自定义表单,image-text--图文详情,coupon--优惠券,timer--倒计时,mch--好店推荐,pintuan--拼团,booking--预约,miaosha--秒杀,bargain--砍价,integral-mall--积分商城,lottery--抽奖,advance--预售,vip-card--超级会员卡,empty--空白块,ad--流量主广告,modal--弹窗广告,quick-nav--快捷导航
├─ data	object	必须		组件数据
├─ color	string	非必须		搜索框颜色 当组件id=search是生效
├─ background	string	非必须		背景色 当组件id=search生效 当组件id=notice生效
├─ radius	number	非必须		边框圆角 当组件id=search时生效
├─ placeholder	string	非必须		提示内容 当组件id=search时生效
├─ textColor	string	非必须		文字颜色 当组件id=search时生效 当组件id=notice时生效
├─ textPosition	string	非必须		提示文字位置 当组件id=search时生效	枚举: left--靠左,center--居中,right--靠右
├─ rows	number	非必须		导航图标每页显示的行数 当组件id=nav时生效
├─ columns	number	非必须		导航图标每行显示的个数 当组件id=nav时生效
├─ scroll	boolean	非必须		是否允许左右滑动 false--不允许|true--允许 当组件id=nav时生效
├─ navs	object []	非必须		导航图标列表 当组件id=nav时生效	item 类型: object
├─ url	string	必须		链接路由
├─ openType	string	必须		链接类型
├─ picUrl	string	必须
├─ text	string	必须
├─ num	string	必须
├─ open_type	string	必须		链接类型
├─ link_url	string	必须		链接路由
├─ name	string	必须		名称
├─ icon_url	string	必须
├─ icon	string	必须		导航图标图片地址
├─ params	object []	必须		链接参数	item 类型: object
├─ key	string	必须		参数key
├─ value	string	必须		参数值
├─ style	number,string	非必须		当组件id=banner时，轮播图样式1--全屏展示|2--卡片形式 当组件id=topic时，专题样式normal--简易模式|list--列表模式
├─ fill	number	非必须		图片填充方式：0--留白|1--填充 当组件id=banner时生效
├─ height	number	非必须		组件高度 当组件id=banner时生效
├─ banners	object []	非必须		轮播图列表	item 类型: object
├─ picUrl	string	非必须		轮播图图片地址
├─ openType	string	非必须		链接类型
├─ url	string	非必须		链接路由
├─ params	object []	非必须		链接参数	item 类型: object
├─ key	string	非必须		参数key
├─ value	string	非必须		参数值
├─ page_url	string	非必须		链接路由
├─ open_type	string	非必须		链接类型
├─ pic_url	string	非必须		轮播图图片地址
├─ name	string	非必须		当组件id=notice时，公告名称
├─ content	string	非必须		当组件id=notice时，公告内容
├─ icon	string	非必须		当组件id=notice时，公告图标
├─ headerUrl	string	非必须		当组件id=notice时，公告弹窗头部图片
├─ btnColor	string	非必须		当组件id=notice时，公告弹窗按钮背景色
├─ btnWidth	number	非必须		当组件id=notice时，公告弹窗按钮宽度
├─ btnHeight	number	非必须		当组件id=notice时，公告弹窗按钮高度
├─ btnRadius	number	非必须		当组件id=notice时，公告弹窗按钮圆角
├─ btnText	string	非必须		当组件id=notice时，公告弹窗文字
├─ btnTextColor	string	非必须		当组件id=notice时，公告弹窗文字颜色
├─ count	number	非必须
├─ logo_1	string	非必须
├─ logo_2	string	非必须
├─ list	object []	非必须			item 类型: object
├─ w	number	必须
├─ h	number	必须
├─ x	number	必须
├─ y	number	必须
├─ link	string []	必须			item 类型: string
├─		非必须
├─ width	string	必须
├─ height	string	必须
├─ left	string	必须
├─ top	string	必须
├─ pic_url	string	必须
├─ backgroundImage	string	必须
├─ backgroundRepeat	string	必须
├─ backgroundSize	string	必须
├─ backgroundPosition	string	必须
├─ zIndex	number	必须
├─ id	number,string	必须
├─ goods_warehouse_id	number	必须
├─ mch_id	number	必须
├─ sign	string	必须
├─ name	string	必须
├─ cover_pic	string	必须
├─ original_price	string	必须
├─ unit	string	必须
├─ page_url	string	必须
├─ is_negotiable	number,string	必须
├─ is_level	number,string	必须
├─ level_price	number	必须
├─ price	string	必须
├─ price_content	string	必须
├─ is_sales	string	必须
├─ sales	string	必须
├─ vip_card_appoint	object	必须
├─ discount	null,string	非必须
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ mobile	string	必须
├─ score	number	必须
├─ longitude	string	必须
├─ latitude	string	必须
├─ picUrl	string	必须
├─ goodsNum	string	必须
├─ orderNum	string	必须
├─ goodsList	object []	必须			item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ picUrl	string	必须
├─ price	string	必须
├─ showGoodsNum	number	必须
├─ staticGoods	boolean	必须
├─ goods_num	string	必须
├─ people_num	number	非必须
├─ pintuan_price	string	非必须
├─ start_time	string	必须
├─ end_time	string	必须
├─ goods_id	string	非必须
├─ mall_id	string	非必须
├─ ladder_rules	string	非必须
├─ deposit	string	非必须
├─ swell_deposit	string	非必须
├─ start_prepayment_at	string	非必须
├─ end_prepayment_at	string	非必须
├─ pay_limit	string	非必须
├─ is_delete	string	非必须
├─ attr	object []	非必须			item 类型: object
├─ id	string	非必须
├─ goods_id	string	非必须
├─ sign_id	string	非必须
├─ stock	string	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	string	非必须
├─ pic_url	string	非必须
├─ is_delete	string	非必须
├─ attr	object	非必须
├─ id	string	非必须
├─ deposit	string	非必须
├─ swell_deposit	string	非必须
├─ goods_id	string	非必须
├─ goods_attr_id	string	非必须
├─ is_delete	string	非必须
├─ advance_num	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	null	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ goodsCatRelation	object []	非必须			item 类型: object
├─ id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ cat_id	string	非必须
├─ is_delete	string	非必须
├─ cats	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ parent_id	string	非必须
├─ name	string	非必须
├─ pic_url	string	非必须
├─ sort	string	非必须
├─ big_pic_url	string	非必须
├─ advert_pic	string	非必须
├─ advert_url	string	非必须
├─ status	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_show	string	非必须
├─ mch	string	非必须
├─ cat_show	boolean	非必须
├─ topic_list	object []	非必须			item 类型: object
├─ id	number	必须
├─ title	string	必须
├─ cover_pic	string	必须
├─ read_count	string	必须
├─ layout	number	必须
├─ pic_list	array,null	必须
├─ title	string	非必须
├─ textLeft	number	非必须
├─ link	object	非必须
├─ type	string	非必须
├─ name	string	非必须
├─ open_type	string	非必须
├─ icon	string	非必须
├─ value	string	非必须
├─ id	number	非必须
├─ new_link_url	string	非必须
├─ url	string	非必须
├─ openType	string	非必须
├─ data	object	非必须
├─ type	string	非必须
├─ name	string	非必须
├─ open_type	string	非必须
├─ icon	string	非必须
├─ value	string	非必须
├─ id	number	非必须
├─ new_link_url	string	非必须
├─ picSwitch	boolean	非必须
├─ arrowsSwitch	boolean	非必须
├─ picUrl	string	非必须
├─ picLeft	number	非必须
├─ space	number	非必须
├─ w	number	非必须
├─ h	number	非必须
├─ hotspot	array,null	非必须
├─ pic_url	string	非必须
├─ url	string	非必须
├─ showCat	boolean	非必须
├─ catPosition	string	非必须
├─ catStyle	number	非必须
├─ catList	string []	非必须			item 类型: string
├─		非必须
├─ listStyle	number	非必须
├─ goodsCoverProportion	string	非必须
├─ goodsStyle	number	非必须
├─ showGoodsName	boolean	非必须
├─ showGoodsPrice	boolean	非必须
├─ showBuyBtn	boolean	非必须
├─ buyBtn	string	非必须
├─ buyBtnStyle	number	非必须
├─ buyBtnText	string	非必须
├─ showGoodsTag	boolean	非必须
├─ customizeGoodsTag	boolean	非必须
├─ goodsTagPicUrl	string	非必须
├─ navPicUrl	string	非必须
├─ scorePicUrl	string	非必须
├─ showName	boolean	非必须
├─ showScore	boolean	非必须
├─ showTel	boolean	非必须
├─ text	string	非必须
├─ backgroundColor	string	非必须
├─ backgroundPicUrl	string	非必须
├─ showText	boolean	非必须
├─ award	object	非必须
├─ continue	number	非必须
├─ number	string	非必须
├─ type	string	非必须
├─ location	string	非必须
├─ paddingY	number	非必须
├─ paddingX	number	非必须
├─ marginTop	number	非必须
├─ marginTopColor	string	非必须
├─ latitude	string	非必须
├─ longitude	number	非必须
├─ position	string,number	非必须
├─ inputPadding	number	非必须
├─ marginBottom	number	非必须
├─ type	number	非必须
├─ times	number	非必须
├─ inputBackground	string	非必须
├─ inputBorder	string	非必须
├─ inputLabel	string	非必须
├─ inputTip	string	非必须
├─ inputText	string	非必须
├─ buttonHeight	number	非必须
├─ buttonPadding	number	非必须
├─ buttonMargin	number	非必须
├─ padding	number	非必须
├─ buttonRadius	number	非必须
├─ borderContent	string	非必须
├─ borderBackground	string	非必须
├─ borderBorder	string	非必须
├─ borderText	string	非必须
├─ marginColor	string	非必须
├─ showImg	boolean	非必须
├─ mode	number	非必须
├─ backgroundHeight	number	非必须
├─ backgroundWidth	number	非必须
├─ formDialog	object []	非必须			item 类型: object
├─ key	string	必须
├─ key_name	string	必须
├─ name	string	必须
├─ is_required	number	必须
├─ receiveBg	string	非必须
├─ unclaimedBg	string	非必须
├─ coupon_list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ name	string	必须
├─ type	string	必须
├─ discount	string	必须
├─ discount_limit	null	必须
├─ pic_url	string	必须
├─ desc	string	必须
├─ min_price	string	必须
├─ sub_price	string	必须
├─ total_count	string	必须
├─ sort	string	必须
├─ expire_type	string	必须
├─ expire_day	string	必须
├─ begin_time	string	必须
├─ end_time	string	必须
├─ appoint_type	string	必须
├─ rule	string	必须
├─ is_member	string	必须
├─ is_delete	string	必须
├─ deleted_at	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ is_receive	string	必须
├─ couponCat	string []	必须			item 类型: string
├─		非必须
├─ cat	string []	必须			item 类型: string
├─		非必须
├─ couponGoods	object []	必须			item 类型: object
├─ id	string	必须
├─ coupon_id	string	必须
├─ goods_warehouse_id	string	必须
├─ is_delete	string	必须
├─ goods	object []	必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ name	string	必须
├─ original_price	string	必须
├─ cost_price	string	必须
├─ detail	string	必须
├─ cover_pic	string	必须
├─ pic_url	string	必须
├─ video_url	string	必须
├─ unit	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ page_url	string	必须
├─ startDateTime	string	非必须
├─ endDateTime	string	非必须
├─ showGoods	boolean	非必须
├─ buttonColor	string	非必须
├─ showCoupon	boolean	非必须
├─ couponColor	string	非必须
├─ couponPicUrl	string	非必须
├─ goodsIndex	number	非必须
├─ start_x	number	非必须
├─ buy_bg	string	非必须
├─ renew_bg	string	非必须
├─ buy_big_color	string	非必须
├─ buy_small_color	string	非必须
├─ buy_btn_color	string	非必须
├─ buy_btn_bg_color	string	非必须
├─ buy_big	string	非必须
├─ buy_small	string	非必须
├─ buy_btn_text	string	非必须
├─ renew_text_color	string	非必须
├─ renew_btn_bg_color	string	非必须
├─ renew_text	string	非必须
├─ usePluginConfig	boolean	非必须
├─ top_bottom_padding	number	非必须
├─ id	string	非必须
├─ opened	boolean	非必须
├─ closedPicUrl	string	非必须
├─ openedPicUrl	string	非必须
├─ navStyle	string	非必须
├─ navSwitch	number	非必须
├─ useMallConfig	boolean	非必须
├─ customerService	object	非必须
├─ picUrl	string	非必须
├─ opened	number	非必须
├─ home	object	非必须
├─ opened	number	非必须
├─ picUrl	string	非必须
├─ mApp	object	非必须
├─ opened	number	非必须
├─ small_app_id	string	非必须
├─ small_app_url	string	非必须
├─ small_app_pic	string	非必须
├─ mapNav	object	非必须
├─ opened	number	非必须
├─ picUrl	string	非必须
├─ address	string	非必须
├─ latitude	string	非必须
├─ longitude	string	非必须
├─ tel	object	非必须
├─ opened	number	非必须
├─ picUrl	string	非必须
├─ number	string	非必须
├─ web	object	非必须
├─ opened	number	非必须
├─ picUrl	string	非必须
├─ url	string	非必须
├─ type	string	非必须		页面数据类型	枚举: mall--首页布局,diy--diy页面数据

首页布局_copy

基本信息

Path： /api/index/index_1573526334729

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page_id	是	0

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ home_pages	object []	非必须			item 类型: object
├─ key	string	必须		组件key	枚举: search--搜索,banner--轮播图,home_nav--导航图标,video--视频,notice--公告,topic--专题,cat--分类,pintuan--拼团,mch--好店推荐,booking--预约,advance--预售,coupon--领券中心,block--图片魔方,miaosha--秒杀,fxhb--裂变红包
├─ name	string	必须		组件名称
├─ relation_id	string	必须
├─ banners	object []	非必须		轮播图 当key=banner时此参数生效	item 类型: object
├─ id	string	非必须		轮播图id
├─ title	string	非必须		轮播图标题
├─ params	object []	非必须		轮播图链接参数	item 类型: object
├─ key	string	必须		参数key
├─ value	string	必须		参数值
├─ open_type	string	非必须		轮播图链接类型
├─ pic_url	string	非必须		轮播图图片
├─ page_url	string	非必须		轮播图路由
├─ row_num	string	非必须		导航图标一行显示数量 当key=home_nav时此参数生效
├─ home_navs	object []	非必须		当key=home_nav时此参数生效	item 类型: object
├─ id	string	必须		导航图标id
├─ icon_url	string	必须		导航图标图标地址
├─ link_url	string	必须		导航图标链接路由
├─ name	string	必须		导航图标名称
├─ open_type	string	必须		导航图标链接类型
├─ params	object []	必须		导航图标链接参数	item 类型: object
├─ key	string	必须		参数key
├─ value	string	必须		参数值
├─ video_url	string	非必须		视频地址 当key=video时此参数生效
├─ video_pic_url	string	非必须		视频封面图 当key=video时此参数生效
├─ notice_url	string	非必须		公告图片地址 当key=notice时此参数生效
├─ notice_bg_color	string	非必须		公告背景色 当key=notice时此参数生效
├─ notice_text_color	string	非必须		公告文字颜色 当key=notice时此参数生效
├─ notice_name	string	非必须		公告名称 当key=notice时此参数生效
├─ notice_content	string	非必须		公告内容 当key=notice时此参数生效
├─ topic_num	string	非必须		专题显示数量 当key=topic时此参数生效
├─ topic_url	string	非必须		一行一个专题图标 当key=topic时此参数生效
├─ topic_url_2	string	非必须		一行两个专题图标 当key=topic时此参数生效
├─ label_url	string	非必须		专题图标 当key=topic时此参数生效
├─ topics	object []	非必须		专题列表 当key=topic时此参数生效	item 类型: object
├─ id	string	必须		专题id
├─ title	string	必须		专题标题
├─ cat_pic_url	string	非必须		分类图片 当key=cat时此参数生效
├─ list_style	string	非必须		分类商品显示样式 当key=cat时此参数生效	枚举: 1--一行一个,2--一行两个,3--一行三个
├─ goods	object []	非必须		商品列表 当key=cat时此参数生效	item 类型: object
├─ id	number	必须		商品id
├─ goods_warehouse_id	number	必须		商品库id
├─ mch_id	number	必须		商品所属商户id
├─ sign	string	必须		商品标示
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		商品封面图
├─ original_price	string	必须		商品原价
├─ unit	string	必须		商品单位
├─ page_url	string	必须		商品路由
├─ is_negotiable	number	必须		是否价格面议0--否1--是
├─ is_level	number	必须		是否享受会员0--否1--是
├─ level_price	number	必须		会员价
├─ price	string	必须		商品售价
├─ price_content	string	必须		商品价格显示文本
├─ is_sales	string	必须		是否显示销量0--否1--是
├─ sales	string	必须		商品销量
├─ vip_card_appoint	object	必须
├─ discount	null	非必须
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ pintuan	object []	非必须		拼团商品列表 当key=pintuan时此参数生效	item 类型: object
├─ id	number	必须		商品id
├─ goods_warehouse_id	number	必须		商品库id
├─ mch_id	number	必须		商品所属商户id
├─ sign	string	必须		商品标示
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		商品封面图
├─ original_price	string	必须		商品原价
├─ unit	string	必须		商品单位
├─ page_url	string	必须		商品路由
├─ is_negotiable	number	必须		是否价格面议0--否1--是
├─ is_level	number	必须		是否享受会员0--否1--是
├─ level_price	number	必须		会员价
├─ price	string	必须		商品售价
├─ price_content	string	必须		商品价格显示文本
├─ is_sales	string	必须		是否显示销量0--否1--是
├─ sales	string	必须		商品销量
├─ vip_card_appoint	object	必须		同商品
├─ discount	string	非必须
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ group_count	string	必须		已拼团数量
├─ mch	object []	非必须		好店推荐 当key=mch时此参数生效	item 类型: object
├─ name	string	必须		商户名称
├─ cover_url	string	必须		商户封面图
├─ mch_id	string	必须
├─ id	string	必须
├─ picUrl	string	必须		商户封面图
├─ booking	object []	非必须		预约 当key=booking时此参数生效	item 类型: object
├─ id	number	必须		商品id
├─ goods_warehouse_id	number	必须		商品库id
├─ mch_id	number	必须		商品所属商户id
├─ sign	string	必须		商品标示
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		商品封面图
├─ original_price	string	必须		商品原价
├─ unit	string	必须		商品单位
├─ page_url	string	必须		商品路由
├─ is_negotiable	number	必须		是否价格面议0--否1--是
├─ is_level	number	必须		是否享受会员0--否1--是
├─ level_price	number	必须		会员价
├─ price	string	必须		商品售价
├─ price_content	string	必须		商品价格显示文本
├─ is_sales	string	必须		是否显示销量0--否1--是
├─ sales	string	必须		商品销量
├─ vip_card_appoint	object	必须
├─ discount	string,null	非必须
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ advance	object	非必须
├─ code	number	非必须
├─ msg	string	非必须
├─ data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ goods_warehouse_id	string	必须
├─ status	string	必须
├─ price	string	必须
├─ use_attr	string	必须
├─ attr_groups	string	必须
├─ goods_stock	number	必须
├─ virtual_sales	string	必须
├─ confine_count	string	必须
├─ pieces	string	必须
├─ forehead	string	必须
├─ freight_id	string	必须
├─ give_integral	string	必须
├─ give_integral_type	string	必须
├─ forehead_integral	string	必须
├─ forehead_integral_type	string	必须
├─ accumulative	string	必须
├─ individual_share	string	必须
├─ attr_setting_type	string	必须
├─ is_level	string	必须
├─ is_level_alone	string	必须
├─ share_type	string	必须
├─ sign	string	必须
├─ app_share_pic	string	必须
├─ app_share_title	string	必须
├─ is_default_services	string	必须
├─ sort	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ payment_people	string	必须
├─ payment_num	string	必须
├─ payment_amount	string	必须
├─ payment_order	string	必须
├─ confine_order_count	string	必须
├─ is_area_limit	string	必须
├─ area_limit	null	必须
├─ share_level_type	string	必须
├─ form_id	string	必须
├─ start_prepayment_at	string	必须
├─ end_prepayment_at	string	必须
├─ goodsWarehouse	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ goodsCatRelation	object []	非必须			item 类型: object
├─ id	string	必须
├─ goods_warehouse_id	string	必须
├─ cat_id	string	必须
├─ is_delete	string	必须
├─ cats	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ parent_id	string	必须
├─ name	string	必须
├─ pic_url	string	必须
├─ sort	string	必须
├─ big_pic_url	string	必须
├─ advert_pic	string	必须
├─ advert_url	string	必须
├─ status	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_show	string	必须
├─ attr	object []	必须			item 类型: object
├─ id	string	必须
├─ goods_id	string	必须
├─ sign_id	string	必须
├─ stock	string	必须
├─ price	string	必须
├─ no	string	必须
├─ weight	string	必须
├─ pic_url	string	必须
├─ is_delete	string	必须
├─ deposit	number	必须
├─ swell_deposit	number	必须
├─ advanceGoods	object	必须
├─ id	string	非必须
├─ goods_id	string	非必须
├─ mall_id	string	非必须
├─ ladder_rules	string	非必须
├─ deposit	number	非必须
├─ swell_deposit	number	非必须
├─ start_prepayment_at	string	非必须
├─ end_prepayment_at	string	非必须
├─ pay_limit	string	非必须
├─ is_delete	string	非必须
├─ cover_pic	string	必须
├─ name	string	必须
├─ price_content	string	必须
├─ original_price	string	必须
├─ page_url	string	必须
├─ sales	string	必须
├─ level_price	number	必须
├─ vip_card_appoint	object	必须
├─ discount	string	非必须
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ coupon_url	string	非必须		已领取优惠券背景图 当key=coupon时此参数生效
├─ coupon_not_url	string	非必须		未领取优惠券背景图 当key=coupon时此参数生效
├─ coupons	object []	非必须		优惠券列表 当key=coupon时此参数生效	item 类型: object
├─ id	string	必须		优惠券id
├─ mall_id	string	必须
├─ name	string	必须		优惠券名称
├─ type	string	必须		优惠券类型：1=折扣，2=满减
├─ discount	string	必须		折扣率
├─ discount_limit	null	必须		折扣优惠上限
├─ min_price	string	必须		最低消费金额
├─ sub_price	string	必须		满减券优惠金额
├─ total_count	string	必须		可发放的数量（剩余数量）
├─ sort	string	必须		排序按升序排列
├─ expire_type	string	必须		到期类型：1=领取后N天过期，2=指定有效期
├─ expire_day	string	必须		有效天数，expire_type=1时
├─ begin_time	string	必须		有效期开始时间
├─ end_time	string	必须		有效期结束时间
├─ appoint_type	string	必须		1 指定分类 2 指定商品 3全部 4.当面付
├─ is_receive	string	必须		已领取数量
├─ block	object	非必须		图片魔方 当key=block时此参数生效
├─ id	string	非必须		图片魔方id
├─ name	string	非必须		图片魔方名称
├─ value	object []	非必须		图片魔方图片列表	item 类型: object
├─ width	string	非必须		图片宽度
├─ height	string	非必须		图片高度
├─ left	number	非必须		图片左边距
├─ top	number	非必须		图片上边距
├─ pic_url	string	非必须		图片地址
├─ link_url	string	非必须		图片链接路由
├─ link	object	非必须		图片链接
├─ type	string	非必须		链接类型
├─ name	string	非必须		链接名称
├─ open_type	string	非必须		链接类型
├─ value	string	非必须
├─ params	object []	非必须		链接参数	item 类型: object
├─ key	string	必须		参数key
├─ value	string	必须		参数值
├─ new_link_url	string	非必须		拼接的路由
├─ type	string	非必须		图片类型	枚举: 1--一张图,2--两张图左右不平分,3--三张图,4--四张图,5--两张图左右平分,6--三张图左右平分,7--四张图左右平分,8--四张图上下左右平分
├─ style	number	非必须		图片魔方高度
├─ miaosha	object	非必须		秒杀 当key=miaosha时此参数生效
├─ open_date	string	非必须		开始日期
├─ open_time	string	非必须		开始时间
├─ date_time	number	非必须		结束时间
├─ is_current	number	非必须
├─ list	object []	非必须		秒杀商品列表	item 类型: object
├─ id	number	必须		商品id
├─ goods_warehouse_id	number	必须		商品库id
├─ mch_id	number	必须		商品所属商户id
├─ sign	string	必须		商品标示
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		商品封面图
├─ original_price	string	必须		商品原价
├─ unit	string	必须		商品单位
├─ page_url	string	必须		商品路由
├─ is_negotiable	number	必须		是否价格面议0--否1--是
├─ is_level	number	必须		是否享受会员0--否1--是
├─ level_price	number	必须		会员价
├─ price	string	必须		商品售价
├─ price_content	string	必须		商品价格显示文本
├─ is_sales	string	必须		是否显示销量0--否1--是
├─ sales	string	必须		商品销量
├─ vip_card_appoint	object	必须
├─ discount	null	非必须
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ fxhb	object []	非必须		裂变红包 当key=fxhb时此参数生效	item 类型: object
├─ picUrl	string	非必须		红包图片
├─ link	object	非必须		红包链接
├─ openType	string	非必须		链接类型
├─ url	string	非必须		链接路由
├─ type	string	非必须	mall	首页类型	枚举: mall--首页布局数据,diy--diy首页数据

门店

门店列表

基本信息

Path： /api/store/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
keyword	是	1	名称关键词
longitude	是	127	经纬度
altitude	是	30	经纬度
goods_id	是	1	商品id
page	是	1	页码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须		多商户id
├─ name	string	必须		门店名称
├─ mobile	string	必须		门店号码
├─ address	string	必须		地址
├─ province_id	string	必须		省id
├─ city_id	string	必须		市id
├─ district_id	string	必须		区id
├─ longitude	string	必须		经度
├─ latitude	string	必须		纬度
├─ score	string	必须		门店评分 0-5
├─ cover_url	string	必须		封面图
├─ pic_url	string	必须		轮播图
├─ business_hours	string	必须		营业时间
├─ description	string	必须		描述
├─ scope	string	必须		范围
├─ is_default	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ distance	string	必须		距当前距离

门店详情

基本信息

Path： /api/store/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	门店id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须		详见门店列表
├─ id	number	非必须
├─ mall_id	number	非必须
├─ mch_id	number	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ address	string	非必须
├─ province_id	number	非必须
├─ city_id	number	非必须
├─ district_id	number	非必须
├─ longitude	string	非必须
├─ latitude	string	非必须
├─ score	number	非必须
├─ cover_url	string	非必须
├─ pic_url	object []	非必须			item 类型: object
├─ id	string	非必须
├─ pic_url	string	非必须
├─ business_hours	string	非必须
├─ description	string	非必须
├─ scope	string	非必须
├─ is_default	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须

足迹

商品足迹

基本信息

Path： /api/footprint/footprint

Method： GET

接口描述：

默认返回今日足迹

请求参数

Query

参数名称	是否必须	示例	备注
start_time	否		开奖时间
end_time	否		结束时间

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
list	object []	非必须			item 类型: object
├─ date	string	必须		日期组
├─ goods	object []	必须		商品信息	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ goods_warehouse_id	string	必须
├─ status	string	必须
├─ price	string	必须
├─ use_attr	string	必须
├─ attr_groups	string	必须
├─ goods_stock	string	必须
├─ virtual_sales	string	必须
├─ confine_count	string	必须
├─ pieces	string	必须
├─ forehead	string	必须
├─ freight_id	string	必须
├─ give_integral	string	必须
├─ give_integral_type	string	必须
├─ forehead_integral	string	必须
├─ forehead_integral_type	string	必须
├─ accumulative	string	必须
├─ individual_share	string	必须
├─ attr_setting_type	string	必须
├─ is_level	string	必须
├─ is_level_alone	string	必须
├─ share_type	string	必须
├─ sign	string	必须
├─ app_share_pic	string	必须
├─ app_share_title	string	必须
├─ is_default_services	string	必须
├─ sort	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ payment_people	string	必须
├─ payment_num	string	必须
├─ payment_amount	string	必须
├─ payment_order	string	必须
├─ confine_order_count	string	必须
├─ is_area_limit	string	必须
├─ area_limit	string,null	必须
├─ share_level_type	string	必须
├─ form_id	string	必须
├─ date_time	string	必须
├─ goodsWarehouse	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ mallGoods	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ goods_id	string	非必须
├─ is_quick_shop	string	非必须
├─ is_sell_well	string	非必须
├─ is_negotiable	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须

我的数据

基本信息

Path： /api/footprint/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
type	否		暂时不用

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pay_price	string	非必须		总消费金额
├─ pay_num	string	非必须		总购买商品数
├─ member_discount_price	string	非必须		总会员优惠金额
├─ coupon_discount_price	string	非必须		总优惠卷优惠金额
├─ coupon_num	string	非必须		总使用优惠卷数
├─ day	string	非必须		我的天数
├─ highest_price	string	非必须		最高消费金额
├─ percentage	string	非必须		消费排行百分比
├─ type	string	非必须		当前查询返回数据的形式，当前为all

足迹删除

基本信息

Path： /api/footprint/footprint-del

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

股东分红--插件

分红明细

基本信息

Path： /plugin/clerk/api/cash/bonus-detail

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ level_list	object []	非必须			item 类型: object
├─ level_name	string	非必须
├─ list	object []	非必须			item 类型: object
├─ user_id	string	必须
├─ level_name	string	必须		等级名
├─ bonus_rate	string	必须		分红比例
├─ price	string	必须		金额
├─ nickname	string	必须		昵称
├─ avatar	string	必须		头像
├─ platform	string	必须		平台
├─ name	string	必须		姓名
├─ phone	string	必须		手机
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

升级

基本信息

Path： /plugin/stock/api/index/level-up

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

升级页面

基本信息

Path： /plugin/stock/api/index/level

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ user	object	非必须
├─ nickname	string	非必须		昵称
├─ avatar	string	非必须		头像
├─ level_name	string	非必须		等级名
├─ level_rate	string	非必须		等级分红比例%
├─ condition	string	非必须		当前用户达到的条件值
├─ is_big_rate	integer	必须		1是最高分红等级，0否
├─ up_type	number	非必须		1下线总人数，2累计佣金总额，3已提现佣金总额，4合伙人订单总数，5合伙人订单总金额
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ name	string	必须		等级名
├─ bonus_rate	string	必须		分红比例%
├─ condition	string	必须		条件值
├─ is_default	string	必须		是否默认
├─ is_delete	string	必须
├─ deleted_at	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ is_this	number	必须		1是用户当前的等级
├─ is_up	number	必须		1当前用户达到了该等级升级条件

是否符合要求

基本信息

Path： /plugin/stock/api/index/index

Method： GET

接口描述：

all_children:下线总人数
all_order:合伙人订单总数
all_money:合伙人订单总金额
cash_money:已提现佣金金额
total_money:累计佣金金额

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	必须
data	object	必须
├─ all_children	number	非必须
├─ pass	boolean	非必须		true:通过 false:未达标
├─ condition	number	非必须		条件

查看审核状态|获取股东信息

基本信息

Path： /plugin/stock/api/index/apply-status

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	必须
msg	string	必须
data	object	必须
├─ stock	object	非必须
├─ id	string	非必须		股东id
├─ mall_id	string	非必须		商城id
├─ user_id	string	非必须		用户id
├─ level_id	string	非必须		等级id
├─ status	string	非必须		-1:再次申请未申请 0:申请中 1:成功 2:拒绝
├─ is_delete	string	非必须
├─ deleted_at	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ applyed_at	string	非必须		申请时间
├─ agreed_at	string	非必须		通过时间
├─ all_bonus	string	非必须		累计分红
├─ total_bonus	string	非必须		当前分红
├─ out_bonus	string	非必须
├─ avatar	string	非必须		头像
├─ level	object	非必须		等级
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ bonus_rate	string	非必须
├─ condition	string	非必须
├─ is_default	string	非必须
├─ is_delete	string	非必须
├─ deleted_at	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ user	object	非必须		股东信息
├─ nickname	string	非必须
├─ id	string	非必须
├─ username	string	非必须
├─ mobile	string	非必须
├─ mall_id	string	非必须
├─ bonus_rate	string	非必须
├─ cash_bonus	string	非必须		已体现分红

清除申请信息

基本信息

Path： /plugin/stock/api/index/clear-apply

Method： POST

接口描述：

当被拒绝或者移除股东后，请求该接口

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	string	非必须

申请提现

基本信息

Path： /plugin/stock/api/index/cash

Method： POST

接口描述：
undefined

请求参数

申请股东

基本信息

Path： /plugin/stock/api/index/apply

Method： POST

接口描述：

当股东设置申请成为股东为  “申请（不填信息）需审核” || ”申请（不填信息）无需审核“      apply_type == 3  或者  4时， name 和 mobile不用填

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
is_agree	text	是	1	是否同意
name	text	是	wwww	姓名
mobile	text	是	13131313131	手机号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

N元任选--插件

下单提交

基本信息

Path： /plugin/pick/api/pick-order/order-submit

Method： GET

接口描述：

请求参数

下单预览

基本信息

Path： /plugin/pick/api/pick-order/order-preview

Method： GET

接口描述：

请求参数

凑单池列表

基本信息

Path： /plugin/pick/api/cart/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
limit	否
page	否

返回数据

名称	类型	是否必须	默认值	备注	其他信息

凑单池删除

基本信息

Path： /plugin/pick/api/cart/delete

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
cart_id_list	是

凑单池添加

基本信息

Path： /plugin/pick/api/cart/add

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
goods_id	是
attr	是
num	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

凑单池编辑

基本信息

Path： /plugin/pick/api/cart/edit

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
list	是

商品列表

基本信息

Path： /plugin/pick/api/index/goods-list

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ goods_warehouse_id	string	必须
├─ status	string	必须
├─ price	string	必须
├─ use_attr	string	必须
├─ attr_groups	string	必须
├─ goods_stock	string	必须
├─ virtual_sales	string	必须
├─ confine_count	string	必须
├─ pieces	string	必须
├─ forehead	string	必须
├─ freight_id	string	必须
├─ give_integral	string	必须
├─ give_integral_type	string	必须
├─ forehead_integral	string	必须
├─ forehead_integral_type	string	必须
├─ accumulative	string	必须
├─ individual_share	string	必须
├─ attr_setting_type	string	必须
├─ is_level	string	必须
├─ is_level_alone	string	必须
├─ share_type	string	必须
├─ sign	string	必须
├─ app_share_pic	string	必须
├─ app_share_title	string	必须
├─ is_default_services	string	必须
├─ sort	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ payment_people	string	必须
├─ payment_num	string	必须
├─ payment_amount	string	必须
├─ payment_order	string	必须
├─ confine_order_count	string	必须
├─ is_area_limit	string	必须
├─ area_limit	string	必须
├─ form_id	string	必须
├─ gppds_stock	string	必须
├─ goodsWarehouse	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ attr	object []	必须			item 类型: object
├─ id	string	必须
├─ goods_id	string	必须
├─ sign_id	string	必须
├─ stock	string	必须
├─ price	string	必须
├─ no	string	必须
├─ weight	string	必须
├─ pic_url	string	必须
├─ is_delete	string	必须
├─ integralMallGoods	null	必须
├─ cover_pic	string	必须
├─ name	string	必须
├─ original_price	string	必须
├─ sales	string	必须
├─ activity	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ status	number	非必须
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ title	string	非必须
├─ start_at	string	非必须
├─ end_at	string	非必须
├─ rule_price	string	非必须
├─ rule_num	number	非必须
├─ is_area_limit	number	非必须
├─ area_limit	string	非必须
├─ bg_url	string	非必须
├─ form	object	非必须
├─ text	object	非必须
├─ color	string	非必须
├─ bg	object	非必须
├─ color	string	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

商品详情

基本信息

Path： /plugin/pick/api/index/goods-detail

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ mch_id	number	非必须
├─ goods_warehouse_id	number	非必须
├─ status	number	非必须
├─ price	string	非必须
├─ use_attr	number	非必须
├─ attr_groups	object []	非必须			item 类型: object
├─ attr_group_id	number	非必须
├─ attr_group_name	string	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ pic_url	string	非必须
├─ goods_stock	number	非必须
├─ virtual_sales	number	非必须
├─ confine_count	number	非必须
├─ pieces	number	非必须
├─ forehead	string	非必须
├─ freight_id	number	非必须
├─ give_integral	number	非必须
├─ give_integral_type	number	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	number	非必须
├─ accumulative	number	非必须
├─ individual_share	number	非必须
├─ attr_setting_type	number	非必须
├─ is_level	number	非必须
├─ is_level_alone	number	非必须
├─ share_type	number	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	number	非必须
├─ sort	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ payment_people	number	非必须
├─ payment_num	number	非必须
├─ payment_amount	string	非必须
├─ payment_order	number	非必须
├─ confine_order_count	number	非必须
├─ is_area_limit	number	非必须
├─ area_limit	string	非必须
├─ form_id	number	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cover_pic	string	非必须
├─ unit	string	非必须
├─ detail	string	非必须
├─ video_url	string	非必须
├─ level_show	number	非必须
├─ is_sales	number	非必须
├─ attr	object []	非必须			item 类型: object
├─ id	number	非必须
├─ goods_id	number	非必须
├─ sign_id	string	非必须
├─ stock	number	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	number	非必须
├─ pic_url	string	非必须
├─ is_delete	number	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ price_member	number	非必须
├─ member_price_list	object []	非必须			item 类型: object
├─ id	number	必须
├─ level	number	必须
├─ price	string	必须
├─ goods_attr_id	number	必须
├─ is_delete	number	必须
├─ goods_id	number	必须
├─ goods_num	number	非必须
├─ goods_no	string	非必须
├─ goods_weight	number	非必须
├─ services	string []	非必须			item 类型: string
├─		非必须
├─ cards	string []	非必须			item 类型: string
├─		非必须
├─ price_min	number	非必须
├─ price_max	number	非必须
├─ pic_url	object []	非必须			item 类型: object
├─ pic_url	string	必须
├─ id	number	必须
├─ share	number	非必须
├─ sales	number	非必须
├─ favorite	boolean	非必须
├─ goods_marketing	object	非必须
├─ limit	string	非必须
├─ pickup	string	非必须
├─ shipping	string	非必须
├─ goods_marketing_award	object	非必须
├─ card	object	非必须
├─ title	string	非必须
├─ list	string []	非必须			item 类型: string
├─		非必须
├─ integral	object	非必须
├─ title	string	非必须
├─ vip_card_appoint	object	非必须
├─ discount	null	非必须
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ express	string	非必须
├─ group_min_member_price	number	非必须
├─ group_max_member_price	number	非必须

海报

基本信息

Path： /plugin/pick/api/index/poster

Method： GET

接口描述：
undefined

请求参数

套餐组合

套餐详情

基本信息

Path： /composition/api/index/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是		页码
goods_id	是		商品id
composition_id	是		展示的套餐id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须		套餐列表	item 类型: object
├─ id	number	必须		套餐id
├─ name	string	必须		套餐名称
├─ type	number	必须		套餐类型	枚举: 1,2 枚举备注: 1--固定套餐 2--搭配套餐
├─ type_text	string	必须		套餐类型中文释义
├─ price	string	必须		优惠金额（仅对固定套餐有效）
├─ stock	number	必须		套餐剩余库存
├─ host_list	object []	必须		主商品列表（仅对搭配套餐有效）同goods_list	item 类型: object
├─ id	number	非必须		套餐商品id
├─ goods_id	number	非必须		商品id
├─ name	string	非必须		商品名称
├─ cover_pic	string	非必须		商品封面图
├─ is_host	number	非必须		是否是主商品
├─ min_price	string	非必须		商品最低价（仅对搭配套餐有效）
├─ attr_groups	object []	非必须		商品规格组	item 类型: object
├─ attr_group_id	number	非必须
├─ attr_group_name	string	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ goods_attr	object []	非必须		商品规格信息	item 类型: object
├─ attr_list	object []	非必须		规格列表	item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ price	string	非必须		规格价格
├─ stock	number	非必须		库存
├─ goods_attr_id	number	非必须		规格id
├─ goods_list	object []	必须		套餐商品列表	item 类型: object
├─ id	number	必须		套餐商品id
├─ goods_id	number	必须		商品id
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		商品封面图
├─ is_host	number	必须		是否是主商品
├─ min_price	string	必须		商品最低价
├─ attr_groups	object []	必须		商品规格组	item 类型: object
├─ attr_group_id	number	必须
├─ attr_group_name	string	必须
├─ attr_list	object []	必须			item 类型: object
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ pic_url	string	必须
├─ goods_attr	object []	必须		商品规格信息	item 类型: object
├─ attr_list	object []	必须		规格列表	item 类型: object
├─ attr_group_name	string	必须
├─ attr_group_id	number	必须
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ price	string,number	必须		规格价格
├─ stock	number	必须		规格库存
├─ goods_attr_id	number	必须		规格id
├─ price	number	必须		优惠金额
├─ detail	object	必须
├─ id	integer	必须		商品id
├─ price	string	必须		商品售价
├─ attr	object []	必须		同goods_attr	item 类型: object
├─ sign	string	必须		商品标示
├─ cover_pic	string	必须		商品封面图
├─ goods_num	string	必须		商品总库存
├─ host_price	string,number	必须		主商品优惠金额（仅对搭配套餐有效）
├─ min_price	string,number	必须		搭配商品最低优惠金额（仅对搭配套餐有效）
├─ max_price	number	必须		搭配商品最高优惠金额（仅对搭配套餐有效）
├─ max_discount	number	必须		最多可优惠金额
├─ min_composition_price	number	必须		最小套餐价

套餐配置

基本信息

Path： /composition/api/index/config

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须
data	object	必须
├─ title	string	必须		规则标题
├─ rule	string	必须		规则内容
├─ activeBg	string	必须		背景图

活动主页

基本信息

Path： /composition/api/index/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是		页码
keyword	否		商品名称

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须		套餐列表	item 类型: object
├─ id	number	必须		套餐id
├─ name	string	必须		套餐名称
├─ type	number	必须		套餐类型	枚举: 1,2 枚举备注: 1--固定套餐 2--搭配套餐
├─ type_text	string	必须		套餐类型中文释义
├─ price	string	必须		优惠金额（仅固定套餐有效）
├─ stock	number	必须		剩余库存
├─ created_at	string	必须		添加时间
├─ goods_list	object []	必须		商品列表	item 类型: object
├─ id	number	必须		套餐商品id
├─ goods_id	number	必须		商品id
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		商品封面图
├─ is_host	number	必须		是否是主商品（仅对搭配套餐有效）	枚举: 0,1 枚举备注: 0--搭配商品 1--主商品
├─ min_price	string,number	必须		规格的最低价
├─ attr_groups	object []	必须		规格组	item 类型: object
├─ attr_group_id	number	必须
├─ attr_group_name	string	必须
├─ attr_list	object []	必须			item 类型: object
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ pic_url	string	必须
├─ goods_attr	object []	必须		商品规格	item 类型: object
├─ attr_list	object []	必须		规格列表	item 类型: object
├─ attr_group_name	string	必须
├─ attr_group_id	number	必须
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ price	string,number	必须		套餐价格（仅对搭配套餐有效）
├─ stock	number	必须		套餐库存（仅对搭配套餐有效）
├─ goods_attr_id	number	必须		规格id
├─ stock	integer	必须		商品库存
├─ price	string	必须		商品优惠金额（仅对搭配套餐有效）
├─ host_price	string,number	必须		主商品优惠金额（仅对搭配套餐有效）
├─ min_price	string,number	必须		搭配商品最低优惠金额（仅对搭配套餐有效）
├─ max_price	string	必须		搭配商品最高优惠金额（仅对搭配套餐有效）
├─ host_list	object []	必须		主商品列表（仅对搭配套餐有效）数据结构同goods_list	item 类型: object
├─ max_discount	number	必须		套餐最多可省

区域代理--插件

判断区域代理状态

基本信息

Path： /plugin/region/api/index/apply-status

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ region	object	非必须
├─ user_id	string	非必须		用户id
├─ level	string	非必须		等级
├─ province_id	string	非必须		省id
├─ status	string	非必须
├─ is_delete	string	非必须
├─ applyed_at	string	非必须
├─ agreed_at	string	非必须
├─ created_at	string	非必须
├─ all_bonus	string	非必须
├─ total_bonus	string	非必须
├─ out_bonus	string	非必须
├─ name	string	非必须
├─ phone	string	非必须
├─ avatar	string	非必须
├─ reason	string	非必须
├─ bonus_rate	string	非必须
├─ cash_bonus	string	非必须
├─ is_up	string	非必须		1可升级 0不可升级
├─ level_up	object	非必须
├─ type	string	非必须		1：下线总人数 2：累计佣金总额 3：已提现佣金总额 4：合伙人订单总数 5：合伙人订单总金额 6：消费金额
├─ level	string	非必须		等级 1：省 2：市 3：区
├─ level_desc	string	非必须
├─ now_target	string	非必须		当前指标
├─ target	string	非必须		目标（条件）指标
├─ pass	string	非必须		是否通过

是否符合要求

基本信息

Path： /plugin/region/api/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
province_id	是	921	省id
level	是	2	1：省代理 2：市代理 3：区代理

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ type	number	非必须		1：下线总人数 2：累计佣金总额 3：已提现佣金总额 4：合伙人订单总数 5：合伙人订单总金额 6：消费金额
├─ level	number	非必须		等级 1：省 2：市 3：区
├─ level_desc	string	非必须
├─ now_target	string	非必须		当前指标
├─ target	string	非必须		目标（条件）指标
├─ pass	boolean	非必须		是否通过

申请代理

基本信息

Path： /plugin/region/api/index/apply

Method： POST

接口描述：

level为2时
必须要city_id

level为3时
必须要district_id

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
province_id	text	是	921	省id
level	text	是	3	1：省代理

2：市代理
3：区代理 |
| is_agree | text | 是 | 1 | 是否同意 |
| mobile | text | 否 | 13131313131 | 电话 |
| name | text | 否 | wjjjjj | 姓名 |
| district_id[] | text | 否 | 966 | 区id |
| city_id[] | text | 否 | 965 | 市id |

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

申请升级

基本信息

Path： /plugin/region/api/index/level-up

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
level	text	是	2	等级

2：升级为市代理
1：升级为省代理 |
| city_id[] | text | 否 | 922 | 市id
level：2时 必填 |

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

获取设置

基本信息

Path： /plugin/region/api/index/setting

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ is_region	number	非必须
├─ region_rate	number	非必须
├─ apply_type	string	非必须
├─ is_agreement	number	非必须
├─ agreement_title	string	非必须
├─ agreement_content	string	非必须
├─ user_instructions	string	非必须
├─ level_up_content	string	非必须
├─ pay_type	string []	非必须			item 类型: string
├─		非必须
├─ min_money	number	非必须
├─ cash_service_charge	number	非必须
├─ free_cash_min	string	非必须
├─ form	object	非必须
├─ bg_url	string	非必须
├─ entry_bonus	string	非必须
├─ title	string	非必须
├─ total_bonus	string	非必须
├─ expect_bonus	string	非必须
├─ cashd_bonus	string	非必须
├─ become_name	string	非必须
├─ statics_text	string	非必须
├─ price_text	string	非必须
├─ can_cash_bonus	string	非必须
├─ orders	string	非必须
├─ statistic_bonus	string	非必须
├─ bottom_bg_url	string	非必须
├─ members	string	非必须
├─ offer_text	string	非必须
├─ audit_result_tpl	string []	非必须			item 类型: string
├─		非必须
├─ remove_identity_tpl	string []	非必须			item 类型: string
├─		非必须
├─ template_message_region	string []	非必须			item 类型: string
├─		非必须
├─ template_message_withdraw	string []	非必须			item 类型: string
├─		非必须

电子卡密

卡密使用说明

基本信息

Path： /plugin/ecard/api/index/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
order_id	是	1	订单id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须
msg	string	必须
data	object	必须
├─ content	string	必须		卡密使用说明
├─ name	string	必须		卡密名称

电子卡密列表

基本信息

Path： /plugin/ecard/api/index/list

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须
data	object []	必须			item 类型: object
├─ id	string	必须		卡密id
├─ name	string	必须		卡密名称
├─ created_at	string	必须		卡密添加时间

社区团购--插件

提货通知

基本信息

Path： /plugin/community/api/middleman/notice

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
activity_id	是		活动id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须
msg	string	非必须

下单提交

基本信息

Path： /plugin/community/api/order/order-submit

Method： GET

接口描述：
undefined

请求参数

分享海报数据获取

基本信息

Path： /plugin/community/api/goods/config

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
goods_id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	非必须
data	object	非必须
├─ config	object	非必须
├─ poster_style	string []	非必须		海报样式	item 类型: string
├─		非必须
├─ image_style	string []	非必须		商品图片数量	item 类型: string
├─		非必须
├─ color	string []	非必须		颜色	item 类型: string
├─		非必须
├─ info	object	非必须
├─ goods_name	string	非必须		商品名称
├─ is_negotiable	number	非必须
├─ min_price	string	非必须		最小价格
├─ max_price	string	非必须		最高价格
├─ multi_map	string []	非必须		商品图片	item 类型: string
├─		非必须
├─ qrcode_url	string	非必须		小程序码
├─ nickname	string	非必须		昵称
├─ avatar	string	非必须		头像
├─ sign	string	非必须		插件标示
code	number	非必须

利润提现

基本信息

Path： /api/finance/cash

Method： POST

接口描述：

提现申请

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
model	text	是		提现的插件类型
price	text	是		提现金额
name	text	是		用户名称
mobile	text	是		联系方式
bank_name'	text	是		开户行
type	text	是		提现方式

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须
msg	string	必须
data	object	非必须
├─ queue_id	integer	必须
├─ token	string	必须

利润提现列表

基本信息

Path： /api/finance/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
model	是	community	提现插件的标示
status	是	-1	提现状态 -1--全部 0--申请中 1--同意 2--已打款 3--驳回
page	是		页码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object	非必须
├─ 2020-07-02	object	非必须
├─ date	string	非必须		时间
├─ list	object []	非必须			item 类型: object
├─ id	number	必须		提现id
├─ order_no	string	必须		提现单号
├─ pay_type	string	必须		提现方式文本
├─ type	string	必须		提现方式
├─ status	number	必须		提现状态	枚举: 0,1,2,3 枚举备注: 0--申请 1--同意 2--已打款 3--驳回
├─ status_text	string	必须		提现状态文本
├─ user	object	必须		用户信息
├─ avatar	string	非必须		用户头像
├─ nickname	string	非必须		用户昵称
├─ platform	string	非必须		所在平台
├─ cash	object	必须		提现信息
├─ price	number	非必须		提现金额
├─ service_charge	number	非必须		手续费
├─ actual_price	number	非必须		实际打款金额
├─ extra	object	必须		额外信息
├─ name	string	非必须		名称
├─ mobile	string	非必须		联系方式
├─ bank_name	string	非必须		开户行
├─ time	object	必须		时间信息
├─ created_at	string	非必须		申请时间
├─ apply_at	string	非必须		审核时间
├─ remittance_at	string	非必须		打款时间
├─ reject_at	string	非必须		驳回时间
├─ content	object	必须		备注信息
├─ apply_content	string	非必须		审核备注
├─ remittance_content	string	非必须		打款备注
├─ reject_content	string	非必须		驳回备注

利润提现配置

基本信息

Path： /api/finance/config

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
model	text	是	community	提现插件标示

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	object	非必须
├─ config	object	非必须		配置信息
├─ pay_type	string []	非必须		提现方式	item 类型: string
├─		非必须
├─ min_money	string	非必须		提现门槛
├─ cash_service_charge	string	非必须		手续费（%）
├─ free_cash_min	string	非必须		免手续费提现门槛
├─ template_message	string []	非必须		提现订阅消息	item 类型: string
├─		非必须

商品海报获取

基本信息

Path： /plugin/community/api/goods/generate

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
style	是	1	海报样式
typesetting	是	1	商品图数量（排版）
type	是	1	类型
goods_id	是		商品id
color	是	#ff7b22	颜色

返回数据

名称	类型	是否必须	默认值	备注	其他信息

商品详情

基本信息

Path： /plugin/community/api/goods/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
goods_id	是		商品id
middleman_id	是		团长的user_id
longitude	是		经度
latitude	是		纬度

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	非必须
data	object	非必须
├─ goods	object	非必须		商品信息，同商品详情
├─ id	number	非必须
├─ mall_id	number	非必须
├─ mch_id	number	非必须
├─ goods_warehouse_id	number	非必须
├─ status	number	非必须
├─ price	string	非必须
├─ use_attr	number	非必须
├─ attr_groups	object []	非必须			item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ pic_url	string	非必须
├─ goods_stock	number	非必须
├─ virtual_sales	number	非必须
├─ confine_count	number	非必须
├─ pieces	number	非必须
├─ forehead	string	非必须
├─ freight_id	number	非必须
├─ give_integral	number	非必须
├─ give_integral_type	number	非必须
├─ give_balance	number	非必须
├─ give_balance_type	number	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	number	非必须
├─ accumulative	number	非必须
├─ individual_share	number	非必须
├─ attr_setting_type	number	非必须
├─ is_level	number	非必须
├─ is_level_alone	number	非必须
├─ share_type	number	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	number	非必须
├─ sort	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ payment_people	number	非必须
├─ payment_num	number	非必须
├─ payment_amount	string	非必须
├─ payment_order	number	非必须
├─ confine_order_count	number	非必须
├─ is_area_limit	number	非必须
├─ area_limit	string	非必须
├─ form_id	number	非必须
├─ sales	number	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cover_pic	string	非必须
├─ unit	string	非必须
├─ detail	string	非必须
├─ video_url	string	非必须
├─ level_show	number	非必须
├─ is_sales	number	非必须
├─ attr	object []	非必须			item 类型: object
├─ id	string	非必须
├─ goods_id	number	非必须
├─ sign_id	string	非必须
├─ stock	string	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	number	非必须
├─ pic_url	string	非必须
├─ is_delete	number	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ price_member	number	非必须
├─ member_price_list	object []	非必须			item 类型: object
├─ id	string	必须
├─ level	number	必须
├─ price	string	必须
├─ goods_attr_id	number	必须
├─ is_delete	number	必须
├─ goods_id	number	必须
├─ goods_num	number	非必须
├─ goods_no	string	非必须
├─ goods_weight	number	非必须
├─ services	string []	非必须			item 类型: string
├─		非必须
├─ cards	string []	非必须			item 类型: string
├─		非必须
├─ price_min	number	非必须
├─ price_max	number	非必须
├─ pic_url	object []	非必须			item 类型: object
├─ pic_url	string	非必须
├─ id	number	非必须
├─ share	number	非必须
├─ favorite	boolean	非必须
├─ goods_marketing	object	非必须
├─ limit	string	非必须
├─ pickup	string	非必须
├─ shipping	string	非必须
├─ goods_marketing_award	object	非必须
├─ card	object	非必须
├─ title	string	非必须
├─ list	string []	非必须			item 类型: string
├─		非必须
├─ integral	object	非必须
├─ title	string	非必须
├─ vip_card_appoint	object	非必须
├─ discount	null	非必须
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ plugin_extra	object	非必须
├─ composition	object	非必须
├─ list	string []	非必须			item 类型: string
├─		非必须
├─ url	string	非必须
├─ express	string	非必须
├─ cats	string []	非必须			item 类型: string
├─		非必须
├─ middleman	object	非必须		团长信息，同团长详情
├─ id	number	非必须		团长id
├─ user_id	number	非必须		团长user_id
├─ name	string	非必须		团长名称
├─ mobile	string	非必须		团长联系方式
├─ location	string	非必须		小区名称
├─ province	string	非必须		省份
├─ city	string	非必须		城市
├─ district	string	非必须		地区
├─ detail	string	非必须		地址
├─ nickname	string	非必须		昵称
├─ avatar	string	非必须		头像
├─ activity	object	非必须		活动信息
├─ start_at	string	非必须		开始时间
├─ status	integer	非必须		状态	枚举: 0,1,2 枚举备注: 0--未开始 1--进行中 2--已结束
├─ time	string	非必须		时间戳
├─ end_at	string	非必须		结束时间
├─ title	string	非必须		活动标题
code	number	非必须

团长信息修改

基本信息

Path： /plugin/community/api/middleman/edit-address

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
detail	text	是		提货地址

返回数据

名称	类型	是否必须	默认值	备注	其他信息

团长列表

基本信息

Path： /plugin/community/api/middleman/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
longitude	是		经度
latitude	是		纬度
page	是		页码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须
data	object []	必须			item 类型: object
├─ list	object []	必须			item 类型: object
├─ id	integer	必须		团长id
├─ user_id	integer	必须		团长用户id
├─ name	string	必须		联系人
├─ mobile	string	必须		联系方式
├─ location	string	必须		小区名称
├─ province	string	必须		省份
├─ city	string	必须		城市
├─ district	string	必须		地区
├─ detail	string	必须		提货地址
├─ nickname	string	必须		昵称
├─ avatar	string	必须		头像
├─ distance	number	必须		距离（m）

团长利润列表

基本信息

Path： /plugin/community/api/middleman/profit-list

Method： GET

接口描述：
undefined

请求参数

团长利润详情

基本信息

Path： /plugin/community/api/middleman/profit-detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是		活动ID
type	是		month当月，day今日

返回数据

名称	类型	是否必须	默认值	备注	其他信息

团长活动列表

基本信息

Path： /plugin/community/api/activity/list

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
status	text	是		-1全部，0未开始，1进行中，2已结束，3下架中
page	text	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

团长活动数据

基本信息

Path： /plugin/community/api/activity/log

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是		活动ID
page	text	是

团长活动详情

基本信息

Path： /plugin/community/api/activity/detail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是		活动ID

团长订单列表

基本信息

Path： /plugin/community/api/order/middle-list

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
keyword	text	是

团长订单详情

基本信息

Path： /plugin/community/api/order/middle-detail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是		订单ID

下单预览

基本信息

Path： /plugin/community/api/order/order-preview

Method： GET

接口描述：
undefined

请求参数

活动商品开关

基本信息

Path： /plugin/community/api/goods/switch

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
activity_id	text	是		活动ID
goods_id	text	是		商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

活动海报

基本信息

Path： /plugin/community/api/activity/poster-config

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
activity_id	是		活动id
middleman_id	是		团长user_id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	非必须
data	object	非必须
├─ config	object	非必须
├─ activity_poster_style	string []	非必须		样式	item 类型: string
├─		非必须
├─ image_bg	string	非必须		背景图
├─ color	string []	非必须		可选颜色	item 类型: string
├─		非必须
├─ info	object	非必须
├─ nickname	string	非必须		用户昵称
├─ avatar	string	非必须		用户头像
├─ activity	object	非必须
├─ title	string	非必须		活动标题
├─ goods_list	object []	非必须		商品列表（最多6个）	item 类型: object
├─ cover_pic	string	必须		封面图
├─ name	string	必须		名称
├─ original_price	string	必须		原价（划线价）
├─ price	string	必须		售价
├─ end_at	string	非必须		活动结束时间
├─ start_at	string	非必须		开始时间
├─ qrcode	string	非必须		小程序码
├─ middleman	object	非必须
├─ name	string	非必须		团长名称
├─ mobile	string	非必须		团长联系方式
├─ avatar	string	非必须		团长头像
├─ province	string	非必须		省
├─ city	string	非必须		市
├─ district	string	非必须		区
├─ detail	string	非必须		提货地址
├─ location	string	非必须		小区地址
code	number	非必须

添加购物车

基本信息

Path： /plugin/community/api/cart/add

Method： GET

接口描述：

购物车编辑使用队列方式处理数据

请求参数

Query

参数名称	是否必须	示例	备注
activity_id	是		活动id
goods_id	是		商品id
goods_attr_id	是		商品规格id
num	是		商品数量

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须
msg	string	非必须
data	object	非必须
├─ token	string	非必须		用于购物车添加结果接口
├─ queue_id	integer	非必须		用于购物车添加结果接口

用户活动详情

基本信息

Path： /plugin/community/api/activity/user-activity

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
id	是		活动ID
page	是

申请成为团长

基本信息

Path： /plugin/community/api/middleman/apply

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
name	text	是		团长昵称
mobile	text	是		联系电话
province_id	text	是		省份id
city_id	text	是		城市id
district_id	text	是		地区id
detail	text	是		提货地址
latitude	text	是		经度
longitude	text	是		纬度
location	text	是		小区名称

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须
msg	string	非必须
data	object	非必须
├─ token	string	非必须		申请结果接口参数
├─ queue_id	integer	非必须		申请结果接口参数

申请结果

基本信息

Path： /plugin/community/api/middleman/apply-result

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
token	是
queue_id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须
msg	string	非必须
data	object	非必须
├─ id	string	非必须

绑定团长

基本信息

Path： /plugin/community/api/middleman/bind

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
middleman_id	是		团长user_id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须

获取团长信息

基本信息

Path： /plugin/community/api/middleman/index

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
msg	string	非必须
data	object	非必须
├─ setting	object	非必须		同设置
├─ is_apply	number	非必须
├─ is_apply_money	number	非必须
├─ is_allow_change	number	非必须
├─ apply_money	number	非必须
├─ apply_money_name	string	非必须
├─ middleman	string	非必须
├─ sell_out_sort	number	非必须
├─ app_share_title	string	非必须
├─ app_share_pic	string	非必须
├─ banner	string	非必须
├─ recruit_title	string	非必须
├─ recruit_content	string	非必须
├─ middleman	object	非必须
├─ money	number	非必须		可提现利润
├─ total_money	number	非必须		累计利润
├─ status	integer	非必须		团长状态	枚举: -1,0,1,2 枚举备注: -1--未支付申请费 0--申请中，待审核 1--审核通过 2--审核后拒绝
├─ delete_first_show	integer	非必须		团长删除后是否显示解除提示	枚举: 0,1 枚举备注: 0--不显示 1--显示
├─ name	string	非必须		团长昵称
├─ moble	string	非必须		团长联系方式
├─ province_id	integer	非必须		省份id
├─ province	string	非必须		省份名称
├─ city_id	integer	非必须		城市id
├─ city	string	非必须		城市名称
├─ district_id	integer	非必须		地区id
├─ district	string	非必须		地区名称
├─ detail	string	非必须		提货地址
├─ latitude	string	非必须		经度
├─ longitude	string	非必须		纬度
├─ location	string	非必须		小区名称
├─ become_at	string	非必须		加入时间（成为团长时间）
code	number	非必须

获取支付id

基本信息

Path： /plugin/community/api/middleman/apply-pay

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是		团长id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须
msg	string	非必须
data	object	非必须
├─ id	string	非必须		支付id

订单列表

基本信息

Path： /plugin/community/api/order/list

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
keyword	text	是

订单详情

基本信息

Path： /plugin/community/api/order/detail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是		订单ID

设置

基本信息

Path： /plugin/community/api/index/setting-data

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ is_apply	number	非必须		是否开启团长审核	枚举: 0,1 枚举备注: 0--不需要 1--需要
├─ is_apply_money	number	非必须		是否开启申请门槛	枚举: 0,1 枚举备注: 0--不开启 1--开启
├─ is_allow_change	number	非必须		是否允许更换团长	枚举: 0,1 枚举备注: 0--不允许 1--允许
├─ apply_money	number	非必须		门槛金额
├─ apply_money_name	string	非必须		门槛金额名称
├─ middleman	string	非必须		社区团购团长名称
├─ sell_out_sort	number	非必须		售罄商品显示方式	枚举: 1,2,3 枚举备注: 1--显示 2--隐藏 3--显示且自动排在最后
├─ app_share_title	string	非必须		分享标题
├─ app_share_pic	string	非必须		分享图片
├─ banner	string	非必须		背景图
├─ recruit_title	string	非必须		招募令标题
├─ recruit_content	string	非必须		招募令内容

购物车列表

基本信息

Path： /plugin/community/api/cart/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
middleman_id	是		团长id
activity_id	是		活动id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须
msg	string	非必须
data	object	非必须
├─ activity_name	string	非必须		活动名称
├─ list	object []	非必须		商品列表	item 类型: object
├─ activity_id	integer	非必须		活动id
├─ community_goods_id	integer	非必须		社区团购商品id
├─ goods_id	integer	非必须		商品id
├─ goods_attr_id	integer	非必须		商品规格id
├─ num	integer	非必须		商品数量
├─ name	string	非必须		商品名称
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	非必须		规格名称
├─ attr_name	string	非必须		规格值
├─ pic_url	string	非必须		图片
├─ price	string	非必须		价格
├─ is_exist	string	非必须		是否有效	枚举: 0,1 枚举备注: 0--无效 1--有效
├─ id	string	非必须		购物车id

购物车删除

基本信息

Path： /plugin/community/api/cart/delete

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
cart_id_list	是		购物车id列表 例：'[1,2,3]'

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须

购物车批量编辑

基本信息

Path： /plugin/community/api/cart/edit

Method： GET

接口描述：

购物车编辑使用队列方式处理数据

请求参数

Query

参数名称	是否必须	示例	备注
list	是		数据结构同购物车列表

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须
msg	string	非必须
data	object	非必须
├─ token	string	非必须		用于购物车添加结果接口
├─ queue_id	string	非必须		用于购物车添加结果接口

购物车添加结果

基本信息

Path： /plugin/community/api/cart/add-result

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
token	text	是
queue_id	text	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须
msg	string	非必须
data	object	非必须
├─ retry	integer	非必须		重新请求改接口

限时抢购

加入购物车

基本信息

Path： /plugin/flash_sale/api/index/add-cart

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
flash_goods_id	text	是	212	限时抢购商品id
attr_id	text	是	2685	商品attr_id
num	text	是	1	数量

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

商品详情

基本信息

Path： /plugin/flash_sale/api/index/goods-detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	212	限时抢购商品id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ mch_id	number	非必须
├─ goods_warehouse_id	number	非必须
├─ status	number	非必须
├─ price	string	非必须
├─ use_attr	number	非必须
├─ attr_groups	object []	非必须			item 类型: object
├─ attr_group_id	number	非必须
├─ attr_group_name	string	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ pic_url	string	非必须
├─ goods_stock	number	非必须
├─ virtual_sales	number	非必须
├─ confine_count	number	非必须
├─ pieces	number	非必须
├─ forehead	string	非必须
├─ freight_id	number	非必须
├─ give_integral	number	非必须
├─ give_integral_type	number	非必须
├─ give_balance	number	非必须
├─ give_balance_type	number	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	number	非必须
├─ accumulative	number	非必须
├─ individual_share	number	非必须
├─ attr_setting_type	number	非必须
├─ is_level	number	非必须
├─ is_level_alone	number	非必须
├─ share_type	number	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	number	非必须
├─ sort	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ payment_people	number	非必须
├─ payment_num	number	非必须
├─ payment_amount	string	非必须
├─ payment_order	number	非必须
├─ confine_order_count	number	非必须
├─ is_area_limit	number	非必须
├─ area_limit	string	非必须
├─ form_id	number	非必须
├─ sales	number	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cover_pic	string	非必须
├─ unit	string	非必须
├─ detail	string	非必须
├─ video_url	string	非必须
├─ level_show	number	非必须
├─ is_sales	number	非必须
├─ attr	object []	非必须			item 类型: object
├─ id	number	非必须
├─ goods_id	number	非必须
├─ sign_id	string	非必须
├─ stock	number	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	number	非必须
├─ pic_url	string	非必须
├─ is_delete	number	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ price_member	string	非必须
├─ member_price_list	string []	非必须			item 类型: string
├─		非必须
├─ attr	object	非必须
├─ id	number	非必须
├─ discount	string	非必须
├─ cut	string	非必须
├─ sale_price	string	非必须
├─ type	number	非必须
├─ goods_id	number	非必须
├─ goods_attr_id	number	非必须
├─ is_delete	number	非必须
├─ goods_num	number	非必须
├─ goods_no	string	非必须
├─ goods_weight	number	非必须
├─ services	string []	非必须			item 类型: string
├─		非必须
├─ cards	string []	非必须			item 类型: string
├─		非必须
├─ price_min	number	非必须
├─ price_max	number	非必须
├─ pic_url	object []	非必须			item 类型: object
├─ id	string	非必须
├─ pic_url	string	非必须
├─ share	number	非必须
├─ favorite	boolean	非必须
├─ goods_marketing	object	非必须
├─ limit	string	非必须
├─ pickup	string	非必须
├─ shipping	string	非必须
├─ goods_marketing_award	object	非必须
├─ card	object	非必须
├─ title	string	非必须
├─ list	string []	非必须			item 类型: string
├─		非必须
├─ integral	object	非必须
├─ title	string	非必须
├─ vip_card_appoint	object	非必须
├─ discount	null	非必须
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ plugin_extra	object	非必须
├─ flash_sale	string []	非必须			item 类型: string
├─		非必须
├─ composition	object	非必须
├─ list	string []	非必须			item 类型: string
├─		非必须
├─ url	string	非必须
├─ express	string	非必须
├─ price_member_max	number	非必须
├─ price_member_min	number	非必须
├─ activity	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ status	number	非必须
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ title	string	非必须		活动标题
├─ start_at	string	非必须		开始时间
├─ end_at	string	非必须		结束时间
├─ notice	number	非必须		活动预告 0不进行预告 1立即预告 2开始前N小时进行预告
├─ notice_hours	number	非必须		提前N小时
├─ is_wipe_zero	number	非必须		是否抹零 0否 1是
├─ wipe_type	number	非必须		1:抹去角和分 2:抹去分
├─ activity_status	number	非必须

活动列表

基本信息

Path： /plugin/flash_sale/api/index/goods-list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
type	是	1	1为正在进行中的活动 2为即将开始的活动
page	否	1
keyword	否	商品标题

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须		活动列表	item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	number	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ give_balance	string	非必须
├─ give_balance_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	string	非必须
├─ form_id	string	非必须
├─ sales	string	非必须
├─ activity_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ type	string	非必须
├─ ecard_id	string	非必须
├─ attr	object []	非必须			item 类型: object
├─ id	string	非必须
├─ goods_id	string	非必须
├─ sign_id	string	非必须
├─ stock	string	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	string	非必须
├─ pic_url	string	非必须
├─ is_delete	string	非必须
├─ attr	object	非必须
├─ id	string	非必须
├─ discount	string	非必须
├─ cut	string	非必须
├─ sale_price	string	非必须
├─ type	string	非必须
├─ goods_id	string	非必须
├─ goods_attr_id	string	非必须
├─ is_delete	string	非必须
├─ flashSaleGoods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ status	string	非必须
├─ goods_id	string	非必须
├─ type	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ activity_id	string	非必须
├─ sort	string	非必须
├─ cover_pic	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ page_url	string	非必须
├─ activity	object	非必须		当前进行中的活动
├─ id	number	非必须
├─ mall_id	number	非必须
├─ status	number	非必须
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ title	string	非必须		活动标题
├─ start_at	string	非必须		开始时间
├─ end_at	string	非必须		结束时间
├─ notice	number	非必须		活动预告 0不进行预告 1立即预告 2开始前N小时进行预告
├─ notice_hours	number	非必须
├─ is_wipe_zero	number	非必须		是否抹零 0否 1是
├─ wipe_type	number	非必须		1:抹去角和分 2:抹去分
├─ next_activity	object	非必须		即将进行的活动
├─ id	number	非必须
├─ mall_id	number	非必须
├─ status	number	非必须
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ title	string	非必须
├─ start_at	string	非必须
├─ end_at	string	非必须
├─ notice	number	非必须
├─ notice_hours	number	非必须
├─ is_wipe_zero	number	非必须
├─ wipe_type	number	非必须
├─ bg_url	string	非必须
├─ form	object	非必须
├─ title	number	非必须
├─ content	string	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

商品批发

商品列表

基本信息

Path： /plugin/wholesale/api/goods/index

Method： GET

接口描述：
undefined

请求参数

商品详情

基本信息

Path： /plugin/wholesale/api/goods/detail

Method： GET

接口描述：
undefined

请求参数

下单预览

基本信息

Path： /plugin/wholesale/api/order/preview

Method： GET

接口描述：
undefined

请求参数

下单提交

基本信息

Path： /plugin/wholesale/api/order/submit

Method： POST

接口描述：
undefined

请求参数

海报

专题海报

基本信息

Path： /api/qrcode/topic

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	专题id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pic_url	string	非必须

合伙人海报

基本信息

Path： /api/qrcode/share

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pic_url	string	非必须

商品海报

基本信息

Path： /api/qrcode/goods

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
goods_id	是	1	商品id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pic_url	string	非必须

签到

用户设置

基本信息

Path： /check_in/api/index/user

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
is_remind	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

自定义数据

基本信息

Path： /plugin/check_in/api/index/customize

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取签到日期

基本信息

Path： /check_in/api/index/sign-in-day

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
month	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

配置

基本信息

Path： /check_in/api/index/index

Method： GET

接口描述：

签到插件配置

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ config	object	非必须
├─ status	number	非必须		是否开启签到
├─ is_remind	number	非必须		是否开启提醒
├─ time	string	非必须		提醒时间
├─ normal_type	string	非必须		普通签到奖励类型integral--积分|balance--余额
├─ normal	string	非必须		普通签到奖励数量
├─ continue	object []	非必须		连续签到设置	item 类型: object
├─ day	number	非必须		连续签到天数
├─ number	number	非必须		连续签到奖励数量
├─ type	string	非必须		连续签到奖励类型integral--积分|balance--余额
├─ total	object []	非必须		累计签到设置	item 类型: object
├─ day	number	非必须		累计签到天数
├─ number	number	非必须		累计签到奖励数量
├─ type	string	非必须		累计签到奖励类型integral--积分|balance--余额
├─ rule	string	非必须		签到规则
├─ check_inuser	object	非必须
├─ continue_day	number	非必须		连续签到天数
├─ total_day	number	非必须		累计签到天数
├─ is_remind	string	非必须		是否开启提醒0--未开启 1--开启
├─ today_check_in	string	非必须		今天签到信息
├─ check_in_day	string []	非必须		签到的日期	item 类型: string
├─		非必须

领取奖励

基本信息

Path： /check_in/api/index/sign-in

Method： GET

接口描述：

领取奖励

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
status	是	1--普通签到奖励 2--连续签到奖励 3--累计签到奖励
day	是	普通签到天数未1

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ queueId	string	非必须
├─ token	string	非必须

领取奖励结果

基本信息

Path： /check_in/api/index/sign-in-result

Method： GET

接口描述：

签到结果

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
queueId	是
token	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ number	string	非必须		奖励数量
├─ type	string	非必须		奖励类型integral--积分|balance--余额
├─ day	number	非必须		签到天数
├─ status	number	非必须		1--普通签到奖励 2--连续签到奖励 3--累计签到奖励

九宫格--抽奖

海报

基本信息

Path： /plugin/pond/api/pond/poster

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pic_url	string	非必须		图片

抽奖

基本信息

Path： /plugin/pond/api/pond/lottery

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ oppty	number	非必须		剩余次数
├─ id	number	非必须		奖品id

活动列表

基本信息

Path： /plugin/pond/mall/pond/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
start_at	是		活动开始时间
end_at	是		活动结束时间
status	是	-1	-1:全部 0：未开始 1：进行中 2：已结束 3：下架中
keyword	是		搜索关键字
keyword_label	是	title	搜索类型 活动名称：title

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须		商城id
├─ status	string	必须		状态 0关闭 1开启
├─ is_delete	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ title	string	必须		活动名称
├─ start_at	string	必须		开始时间
├─ end_at	string	必须		结束时间
├─ deplete_integral_num	string	必须		消耗积分
├─ pond_type	string	必须		1.天 2.用户 默认为2
├─ oppty	string	必须		抽奖次数
├─ hint_text	string	必须		未中奖提示
├─ lottery_count	string	必须		抽奖人数
├─ prize_count	string	必须		中奖人数
├─ pond	object []	必须		九宫格奖品	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须		商城id
├─ name	string	必须		名称
├─ type	string	必须		1.红包2.优惠卷3.积分4.实物.5.无
├─ probability	string	必须		概率
├─ goods_id	string	必须		商品id
├─ num	string	必须		积分数量
├─ price	string	必须		红包价格
├─ image_url	string	必须		图片
├─ coupon_id	string	必须		优惠券
├─ stock	string	必须		库存
├─ created_at	string	必须
├─ updated_at	string	必须
├─ pond_activity_id	string	必须		活动id
├─ is_delete	string	必须
├─ coupon	null	必须
├─ goods	null	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

活动记录

基本信息

Path： /plugin/pond/mall/log/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	否	1	活动id 不传时返回所有

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ pond_id	string	必须		活动id
├─ user_id	string	必须		用户id
├─ status	string	必须		0预领取 1 未领取 2 已领取
├─ type	string	必须		1.红包2.优惠卷3.积分4.实物5无
├─ num	string	必须		积分数量
├─ detail	string	必须		优惠券信息
├─ goods_id	string	必须		商品id
├─ price	string	必须		价格
├─ order_id	string	必须		订单id
├─ raffled_at	string	必须
├─ created_at	string	必须
├─ pond_activity_id	string	必须
├─ coupon	null	必须
├─ goods	null	必须
├─ user	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须
├─ nickname	string	必须
├─ avatar	string	必须
├─ name	string	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

活动详情

基本信息

Path： /plugin/pond/mall/pond/edit

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	活动id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ activity	object	非必须		活动
├─ id	string	非必须
├─ mall_id	string	非必须		商城id
├─ status	string	非必须		0关闭 1开启
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ title	string	非必须		活动名称
├─ start_at	string	非必须		开始时间
├─ end_at	string	非必须		结束时间
├─ deplete_integral_num	string	非必须		消耗积分
├─ pond_type	string	非必须		1天 2用户 默认为2
├─ oppty	string	非必须		抽奖次数
├─ hint_text	string	非必须		未中奖提示语
├─ pond	object []	非必须		九宫格奖品列表	item 类型: object
├─ id	string,number	必须
├─ mall_id	string	必须		商城id
├─ name	string	必须		名称
├─ type	string	必须		1.红包2.优惠卷3.积分4.实物.5.无
├─ probability	string	必须		中将概率
├─ goods_id	string,number	必须		商品id
├─ num	string,number	必须		积分数量
├─ price	string,number	必须		价格
├─ image_url	string	必须		图片
├─ coupon_id	number	必须		优惠券
├─ stock	string,number	必须		库存
├─ created_at	string	必须
├─ updated_at	string	必须
├─ pond_activity_id	string	必须		活动id
├─ is_delete	string	必须
├─ coupon	null	必须
├─ goods	null	必须
├─ attr_id	number	必须
├─ coupon	object []	非必须		优惠券列表	item 类型: object
├─ id	number	必须
├─ mall_id	number	必须
├─ name	string	必须		名称
├─ type	number	必须		1为折扣券 2为满减券
├─ discount	string	必须		折扣
├─ discount_limit	null,string	必须		折扣上限 type为1时有用
├─ pic_url	number	必须		图品
├─ desc	string	必须		描述
├─ min_price	string	必须		最小使用金额
├─ sub_price	string	必须		满减
├─ total_count	number	必须
├─ sort	number	必须
├─ expire_type	number	必须		类型
├─ expire_day	number	必须		过期时间
├─ begin_time	string	必须		开始时间
├─ end_time	string	必须		结束时间
├─ appoint_type	number	必须
├─ rule	string	必须
├─ is_member	number	必须
├─ is_delete	number	必须
├─ deleted_at	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须

新增/编辑活动

基本信息

Path： /plugin/pond/mall/pond/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
pond_activity_id	text	是	19	无 为新增 有为编辑
title	text	是	tersst	活动名称
start_at	text	是	2019-11-18 15	开始时间
end_at	text	是	2019-11-19 15	结束时间
hint_text	text	是	谢谢惠4顾~	未中奖提示语
oppty	text	是	30	抽奖次数
scratch_type	text	是	2	1：天 2：用户 默认为2
deplete_integral_num	text	是	0	积分抵扣值
status	text	是	1	0关闭 1开启
prize[0][probability]	text	是	10
prize[0][type]	text	是	1
prize[0][stock]	text	是	100
prize[0][goods_id]	text	是	33
prize[1][probability]	text	是	10
prize[1][type]	text	是	3
prize[1][stock]	text	是	80
prize[1][integral_num]	text	是	5
prize[0][sign_id]	text	是	1
prize[0][price]	text	是	111

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

订单提交

基本信息

Path： /plugin/pond/api/pond/order-submit

Method： GET

接口描述：
undefined

请求参数

订单预览

基本信息

Path： /plugin/pond/api/pond/order-preview

Method： GET

接口描述：
undefined

请求参数

记录

基本信息

Path： /plugin/pond/api/pond/prize

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1	页面

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须		记录id
├─ mall_id	string	非必须
├─ pond_id	string	非必须		抽奖id
├─ user_id	string	非必须
├─ status	string	非必须		0未领取1 已领取
├─ type	string	非必须		1.红包2.优惠卷3.积分4.实物.5.无
├─ num	string	非必须		积分数
├─ detail	string	非必须		积分详情
├─ goods_id	string	非必须		商品id
├─ price	string	非必须		价格
├─ order_id	string	非必须		实物订单id
├─ raffled_at	string	非必须		领取时间
├─ created_at	string	非必须
├─ goods	null	非必须		商品信息
├─ coupon	null	非必须		优惠券信息
├─ name	string	非必须		名称

配置

基本信息

Path： /plugin/pond/api/pond/setting

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ setting	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ title	string	非必须		小程序标题
├─ type	number	非必须		1.天 2 用户
├─ probability	number	非必须		概率
├─ oppty	number	非必须		抽奖次数
├─ start_at	string	非必须		开始时间
├─ end_at	string	非必须		结束时间
├─ deplete_integral_num	number	非必须		消耗积分
├─ rule	string	非必须		规则
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ payment_type	string []	非必须		支付方式	item 类型: string
├─		非必须
├─ send_type	string []	非必须		发货方式	item 类型: string
├─		非必须
├─ is_sms	number	非必须		开启短信提醒0关闭 1开启
├─ is_mail	number	非必须		开启邮件提醒0关闭 1开启
├─ is_print	number	非必须		开启打印0关闭 1开启

首页

基本信息

Path： /plugin/pond/api/pond/index

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ oppty	number	非必须		剩余机会
├─ setting	object	非必须		详见配置
├─ id	number	非必须
├─ mall_id	number	非必须
├─ title	string	非必须
├─ type	number	非必须
├─ probability	number	非必须
├─ oppty	number	非必须
├─ start_at	string	非必须
├─ end_at	string	非必须
├─ deplete_integral_num	number	非必须
├─ rule	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ payment_type	string []	非必须			item 类型: string
├─		非必须
├─ send_type	string []	非必须			item 类型: string
├─		非必须
├─ is_sms	number	非必须
├─ is_mail	number	非必须
├─ is_print	number	非必须
├─ list	object []	非必须		奖品列表	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ name	string	必须		名称
├─ type	string	必须		1.红包2.优惠卷3.积分4.实物.5.无
├─ goods_id	string	必须		商品id
├─ num	string	必须		积分数
├─ price	string	必须		价格
├─ image_url	string	必须		图片
├─ coupon_id	string	必须		优惠券id
├─ stock	string	必须		库存
├─ created_at	string	必须
├─ updated_at	string	必须
├─ goods	object,null	必须		商品信息
├─ coupon	object	必须		优惠券信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ type	string	非必须
├─ discount	string	非必须
├─ discount_limit	null	非必须
├─ pic_url	string	非必须
├─ desc	string	非必须
├─ min_price	string	非必须
├─ sub_price	string	非必须
├─ total_count	string	非必须
├─ sort	string	非必须
├─ expire_type	string	非必须
├─ expire_day	string	非必须
├─ begin_time	string	非必须
├─ end_time	string	非必须
├─ appoint_type	string	非必须
├─ rule	string	非必须
├─ is_member	string	非必须
├─ is_delete	string	非必须
├─ deleted_at	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

刮刮卡--插件

订单提交

基本信息

Path： /plugin/scratch/api/scratch/order-submit

Method： GET

接口描述：
undefined

请求参数

中奖名单数据

基本信息

Path： /plugin/scratch/api/scratch/record

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ scratch_id	string	必须
├─ user_id	string	必须
├─ status	string	必须		0预领取 1 未领取 2 已领取
├─ type	string	必须		1.红包2.优惠卷3.积分4.实物5无
├─ num	string	必须		积分数量
├─ price	string	必须		价格
├─ order_id	string	必须
├─ goods_id	string	必须
├─ raffled_at	string	必须
├─ created_at	string	必须
├─ is_delete	string	必须
├─ deleted_at	string	必须
├─ scratch_activity_id	string	必须		活动id
├─ create_time	string	必须		时间
├─ goods	object	必须		商品信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	null	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ user	string	必须		用户名
├─ coupon	null	必须		优惠券信息
├─ name	string	必须		奖品名称

活动列表

基本信息

Path： /plugin/scratch/mall/scratch/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
start_at	否		活动开始时间
end_at	否		活动结束时间
status	否	-1	-1:全部 0：未开始 1：进行中 2：已结束 3：下架中
keyword	是		搜索关键字
keyword_label	是		搜索类型 活动名称：title

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须		商城id
├─ status	string	非必须		状态 0关闭 1开启
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ title	string	非必须		活动名称
├─ start_at	string	非必须		开始时间
├─ end_at	string	非必须		结束时间
├─ deplete_integral_num	string	非必须		消耗积分
├─ scratch_type	string	非必须		1：天 2：用户 默认为2
├─ oppty	string	非必须		抽奖次数
├─ hint_text	string	非必须		未中奖提示语
├─ lottery_count	string	非必须		抽奖人数
├─ prize_count	string	非必须		中奖人数
├─ scratch	object []	非必须		奖品列表	item 类型: object
├─ id	string	必须		奖品id
├─ mall_id	string	必须		商品id
├─ type	string	必须		1.红包2.优惠卷3.积分4.实物.5.无
├─ probability	string	必须		概率
├─ status	string	必须		状态 0 关闭 1开启
├─ goods_id	string	必须		商品id
├─ num	string	必须		积分数量
├─ price	string	必须		红包价格
├─ coupon_id	string	必须		优惠券
├─ stock	string	必须		库存
├─ is_delete	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ scratch_activity_id	string	必须		活动id
├─ coupon	null	必须		卡券详情
├─ goods	null	必须		商品详情
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

活动数据

基本信息

Path： /plugin/scratch/mall/log/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	否	1	活动id 不传则返回全部活动抽奖记录

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须		抽奖记录	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须		商城id
├─ scratch_id	string	必须		奖品id
├─ user_id	string	必须		用户id
├─ status	string	必须		0预领取 1 未领取 2 已领取
├─ type	string	必须		1.红包2.优惠卷3.积分4.实物5无
├─ num	string	必须		积分数量
├─ detail	string	必须		优惠券信息
├─ price	string	必须		价格
├─ order_id	string	必须		订单id
├─ goods_id	string	必须		商品id
├─ raffled_at	string	必须
├─ created_at	string	必须
├─ is_delete	string	必须
├─ deleted_at	string	必须
├─ scratch_activity_id	string	必须		活动id
├─ coupon	null	必须
├─ goods	null	必须
├─ nickname	string	必须
├─ avatar	string	必须
├─ name	string	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

添加/编辑活动

基本信息

Path： /plugin/scratch/mall/scratch/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
scratch_activity_id	text	否	1	无 为新增 有为编辑
title	text	是	这是活动名称啊	活动名称
start_at	text	是	2019-11-07 15:53:23	开始时间
end_at	text	是	2019-11-17 15:53:23	结束时间
hint_text	text	是	谢谢惠顾~	未中奖提示语
oppty	text	是	30	抽奖次数
scratch_type	text	是	2	1：天 2：用户 默认为2
deplete_integral_num	text	是	0	积分抵扣值
status	text	是	1	0关闭 1开启
prize[0][probability]	text	是	10
prize[0][type]	text	是	1
prize[0][stock]	text	是	100
prize[0][price]	text	是	5
prize[1][probability]	text	是	10
prize[1][type]	text	是	3
prize[1][stock]	text	是	80
prize[1][integral_num]	text	是	5

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

刮刮卡海报

基本信息

Path： /plugin/scratch/api/scratch/poster

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pic_url	string	非必须		图片

订单预览

基本信息

Path： /plugin/scratch/api/scratch/order-preview

Method： GET

接口描述：
undefined

请求参数

记录

基本信息

Path： /plugin/scratch/api/scratch/prize

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1	页面

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ scratch_id	string	必须
├─ user_id	string	必须
├─ status	string	必须		0预领取 1 未领取 2 已领取
├─ type	string	必须		1.红包2.优惠卷3.积分4.实物5无
├─ num	string	必须		积分数
├─ detail	string	必须		优惠券信息
├─ price	string	必须		价格
├─ order_id	string	必须
├─ goods_id	string	必须
├─ raffled_at	string	必须
├─ created_at	string	必须
├─ is_delete	string	必须
├─ deleted_at	string	必须
├─ scratch_activity_id	string	必须		活动id
├─ goods	object,null	必须		商品信息
├─ coupon	null	必须		优惠券信息
├─ attr_list	object []	必须		规格信息	item 类型: object
├─ attr_group_name	string	必须
├─ attr_group_id	number	必须
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ attr_id	string	必须		规格id
├─ name	string	必须		奖品名称

配置

基本信息

Path： /plugin/scratch/api/scratch/setting

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ setting	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ title	string	非必须		小程序标题
├─ type	number	非必须		1.天 2 用户
├─ probability	number	非必须		概率
├─ oppty	number	非必须		抽奖次数
├─ start_at	string	非必须		开始时间
├─ end_at	string	非必须		结束时间
├─ deplete_integral_num	number	非必须		消耗积分
├─ rule	string	非必须		规则
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ payment_type	string []	非必须		支付方式	item 类型: string
├─		非必须
├─ send_type	string []	非必须		发货方式	item 类型: string
├─		非必须
├─ is_sms	number	非必须		开启短信提醒0关闭1开启
├─ is_mail	number	非必须		开启邮件提醒0关闭1开启
├─ is_print	number	非必须		开启打印0关闭1开启

领取奖品

基本信息

Path： /plugin/scratch/api/scratch/receive

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	奖品记录id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须		详见首页
├─ list	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ scratch_id	number	非必须
├─ user_id	number	非必须
├─ status	number	非必须
├─ type	number	非必须
├─ num	number	非必须
├─ detail	string	非必须
├─ price	string	非必须
├─ order_id	number	非必须
├─ goods_id	number	非必须
├─ raffled_at	string	非必须
├─ created_at	string	非必须
├─ is_delete	number	非必须
├─ deleted_at	string	非必须
├─ scratch_activity_id	number	非必须
├─ name	string	非必须
├─ setting	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ title	string	非必须
├─ type	number	非必须
├─ probability	number	非必须
├─ oppty	number	非必须
├─ start_at	string	非必须
├─ end_at	string	非必须
├─ deplete_integral_num	number	非必须
├─ rule	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ payment_type	string []	非必须			item 类型: string
├─		非必须
├─ send_type	string []	非必须			item 类型: string
├─		非必须
├─ is_sms	number	非必须
├─ is_mail	number	非必须
├─ is_print	number	非必须
├─ oppty	number	非必须

首页

基本信息

Path： /plugin/scratch/api/scratch/index

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须		商城id
├─ scratch_id	number	非必须		奖品id
├─ user_id	number	非必须		用户id
├─ status	number	非必须		0预领取 1 未领取 2 已领取
├─ type	number	非必须		1.红包2.优惠卷3.积分4.实物5无
├─ num	number	非必须		积分数量
├─ detail	string	非必须		优惠券信息
├─ price	string	非必须		价格
├─ order_id	number	非必须		订单id
├─ goods_id	number	非必须		商品id
├─ raffled_at	string	非必须
├─ created_at	string	非必须
├─ is_delete	number	非必须
├─ deleted_at	string	非必须
├─ scratch_activity_id	number	非必须		活动id
├─ name	string	非必须
├─ activity	object	非必须		活动
├─ id	number	非必须
├─ mall_id	number	非必须		商城id
├─ status	number	非必须		状态 0关闭 1开启
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ title	string	非必须		活动名称
├─ start_at	string	非必须		开始时间
├─ end_at	string	非必须		结束时间
├─ deplete_integral_num	number	非必须		消耗积分
├─ scratch_type	number	非必须		1天 2用户 默认为2
├─ oppty	number	非必须		抽奖次数
├─ hint_text	string	非必须		未中奖提示语
├─ oppty	number	非必须

幸运抽奖--插件

商品详情

基本信息

Path： /plugin/lottery/api/lottery/goods

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ goods	object	非必须		商品信息
├─ attr_id	string	非必须		规格id
├─ attr_list	object []	非必须		规格列表	item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ pic_url	object []	非必须		轮播图	item 类型: object
├─ id	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须		商品链接
├─ name	string	非必须		名称
├─ num	string	非必须		数量
├─ original_price	string	非必须		原价
├─ detail	string	非必须		详情
├─ id	string	非必须
├─ lottery	object	非必须		奖品信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ goods_id	string	非必须
├─ buy_goods_id	string	非必须		原商品id
├─ status	string	非必须		0关闭 1开启
├─ type	string	非必须		0未完成 1已完成 2超限 3过期
├─ stock	string	非必须		库存
├─ start_at	string	非必须		开始时间
├─ end_at	string	非必须		结束时间
├─ join_min_num	string	非必须		参加最少人数限制
├─ sort	string	非必须		排序
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ participant	string	非必须		参与人
├─ invitee	string	非必须		被邀请人
├─ code_num	string	非必须		抽奖券码数量
├─ title	string	非必须		活动标题
├─ goods	object	非必须		商品信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	string	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ attr	object []	非必须			item 类型: object
├─ id	string	必须
├─ goods_id	string	必须
├─ sign_id	string	必须
├─ stock	string	必须
├─ price	string	必须
├─ no	string	必须
├─ weight	string	必须
├─ pic_url	string	必须
├─ is_delete	string	必须
├─ lucky_list	object []	非必须		中奖列表	item 类型: object
├─ lucky_num	string	必须		幸运码
├─ user_id	string	必须
├─ child_id	string	必须		被邀请人id
├─ status	string	必须		0未抽奖 1待开奖 2未中奖 3中奖 4已领取
├─ lucky_code	string	必须		幸运码
├─ created_at	string	必须
├─ lottery_id	string	必须
├─ user	object	必须		中奖人信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须		名称
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须
├─ user_log	object	非必须		用户记录
├─ id	number	非必须
├─ mall_id	number	非必须
├─ user_id	number	非必须
├─ lottery_id	number	非必须
├─ status	number	非必须		0未抽奖 1待开奖 2未中奖 3中奖 4已领取
├─ goods_id	number	非必须		商品id
├─ child_id	number	非必须		被邀请人id
├─ lucky_code	string	非必须		幸运码
├─ raffled_at	string	非必须
├─ obtain_at	string	非必须
├─ created_at	string	非必须

奖品记录

基本信息

Path： /plugin/lottery/api/lottery/prize

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
type	是	1	1进行中 2中奖 3未中奖
page	是	1	页码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ lottery_id	string	必须		奖品id
├─ status	string	必须		0未抽奖 1待开奖 2未中奖 3中奖 4已领取
├─ goods_id	string	必须
├─ child_id	string	必须
├─ lucky_code	string	必须		幸运码
├─ raffled_at	string	必须
├─ obtain_at	string	必须
├─ created_at	string	必须
├─ lottery	object	必须		抽奖信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ goods_id	string	非必须
├─ buy_goods_id	string	非必须		原商品id
├─ status	string	非必须		0关闭 1开启
├─ type	string	非必须		0未完成 1已完成 2超限 3过期
├─ stock	string	非必须		库存
├─ start_at	string	非必须		开始时间
├─ end_at	string	非必须		结束时间
├─ join_min_num	string	非必须		参加最少人数限制
├─ sort	string	非必须		排序
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ participant	string	非必须		参与人
├─ invitee	string	非必须		被邀请人
├─ code_num	string	非必须		抽奖券码数量
├─ title	string	非必须		活动标题
├─ goods	object	必须		商品信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	null,string	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须		商品名称
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ attr	object []	非必须			item 类型: object
├─ id	string	必须
├─ goods_id	string	必须
├─ sign_id	string	必须
├─ stock	string	必须
├─ price	string	必须
├─ no	string	必须
├─ weight	string	必须
├─ pic_url	string	必须
├─ is_delete	string	必须
├─ time	string	必须		开奖时间

奖品详情

基本信息

Path： /plugin/lottery/api/lottery/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
lottery_id	是	1	奖品id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须		抽奖信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ lottery_id	string	非必须
├─ status	string	非必须		0未抽奖 1待开奖 2未中奖 3中奖 4已领取
├─ goods_id	string	非必须
├─ child_id	string	非必须		被邀请id
├─ lucky_code	string	非必须		幸运码
├─ raffled_at	string	非必须
├─ obtain_at	string	非必须
├─ created_at	string	非必须
├─ parent_num	number	非必须		邀请好友数
├─ goods	object	非必须		商品信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	string	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须		商品名称
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ attr	object []	非必须			item 类型: object
├─ id	string	必须
├─ goods_id	string	必须
├─ sign_id	string	必须
├─ stock	string	必须
├─ price	string	必须
├─ no	string	必须
├─ weight	string	必须
├─ pic_url	string	必须
├─ is_delete	string	必须
├─ attr_id	string	非必须
├─ lottery	object	非必须		奖品信息 详见首页
├─ id	string	非必须
├─ mall_id	string	非必须
├─ goods_id	string	非必须
├─ buy_goods_id	string	非必须
├─ status	string	非必须
├─ type	string	非必须
├─ stock	string	非必须
├─ start_at	string	非必须
├─ end_at	string	非必须
├─ join_min_num	string	非必须
├─ sort	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ participant	string	非必须
├─ invitee	string	非必须
├─ code_num	string	非必须
├─ title	string	非必须
├─ attr	object	非必须		规格信息
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ time	string	非必须		开奖时间
├─ num	string	非必须		参与数
├─ user_list	object []	非必须		参与列表	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ lottery_id	string	必须
├─ status	string	必须		0未抽奖 1待开奖 2未中奖 3中奖 4已领取
├─ goods_id	string	必须
├─ child_id	string	必须
├─ lucky_code	string	必须		幸运码
├─ raffled_at	string	必须
├─ obtain_at	string	必须
├─ created_at	string	必须
├─ user	object	必须		用户信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须		用户头像
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须

幸运码

基本信息

Path： /plugin/lottery/api/lottery/code

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1	页码
lottery_id	是	1	抽奖记录id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ own	object	非必须		本人幸运码信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ lottery_id	string	非必须		抽奖id
├─ status	string	非必须		0未抽奖 1待开奖 2未中奖 3中奖 4已领取
├─ goods_id	string	非必须
├─ child_id	string	非必须		被邀请人id
├─ lucky_code	string	非必须		幸运码
├─ raffled_at	string	非必须
├─ obtain_at	string	非必须
├─ created_at	string	非必须
├─ user	object	非必须		用户信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须		用户名称
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须
├─ parent	string []	非必须		邀请人列表	item 类型: string
├─		非必须
├─ award	string []	非必须		中奖记录	item 类型: string
├─		非必须
├─ num	number	非必须		持有数量

海报

基本信息

Path： /plugin/lottery/api/lottery/poster

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pic_url	string	非必须		图片

订单提交

基本信息

Path： /plugin/lottery/api/lottery/order-submit

Method： GET

接口描述：
undefined

请求参数

订单预览

基本信息

Path： /plugin/lottery/api/lottery/order-preview

Method： GET

接口描述：
undefined

请求参数

邀请机会

基本信息

Path： /plugin/lottery/api/lottery/clerk

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
user_id	text	是		邀请人id
lottery_id	text	是	1	奖品id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

配置

基本信息

Path： /plugin/lottery/api/lottery/setting

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ setting	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ type	number	非必须		0：分享即送 1： 被分享人参与抽奖
├─ title	string	非必须		小程序标题
├─ rule	string	非必须		规则
├─ created_at	string	非必须
├─ payment_type	string []	非必须		支付方式	item 类型: string
├─		非必须
├─ send_type	string []	非必须		发货方式	item 类型: string
├─		非必须
├─ goods_poster	object	非必须		海报自定义信息
├─ bg_pic	object	非必须
├─ url	string	非必须
├─ pic	object	非必须
├─ is_show	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_type	string	非必须
├─ head	object	非必须
├─ is_show	number	非必须
├─ size	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_type	string	非必须
├─ nickname	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ nickname_share	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ width	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ poster_bg	object	非必须
├─ is_show	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_path	string	非必须
├─ file_type	string	非必须
├─ poster_bg_two	object	非必须
├─ is_show	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_path	string	非必须
├─ file_type	string	非必须
├─ qr_code	object	非必须
├─ is_show	number	非必须
├─ size	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ type	number	非必须
├─ file_path	string	非必须
├─ file_type	string	非必须
├─ name	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ desc	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ width	number	非必须
├─ price	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ del_line	string	非必须
├─ color	string	非必须
├─ text	string	非必须
├─ file_type	string	非必须
├─ line_url	object	非必须
├─ is_show	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ file_path	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ is_sms	number	非必须		开启短信提醒0关1开
├─ is_mail	number	非必须		开启邮件提醒0关 1开
├─ is_print	number	非必须		开启打印0关 1开
├─ cs_status	number	非必须		是否开启客服提示 0关 1开
├─ cs_prompt_pic	string	非必须		客服提示图片
├─ cs_wechat	string	非必须		客服微信号
├─ cs_wechat_qrcode	string	非必须		客服微信号二维码
├─ cs_wechat_flock_qrcode	string	非必须		微信群二维码

首页

基本信息

Path： /plugin/lottery/api/lottery/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1	页码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ banner_list	object []	非必须		轮播图数据	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ pic_url	string	必须		轮播图图片
├─ title	string	必须		轮播图名称
├─ page_url	string	必须		跳转url
├─ open_type	string	必须		跳转类型
├─ params	string	必须		跳转参数
├─ is_delete	string	必须
├─ created_at	string	必须
├─ deleted_at	string	必须
├─ updated_at	string	必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ stock	string	非必须		库存
├─ end_at	string	非必须		结束时间
├─ status	number	非必须		0关闭 1开启
├─ lottery_log_count	string	非必须		参与数
├─ cover_pic	string	非必须		封面图
├─ goods_name	string	非必须		商品名
├─ price	string	非必须		原价

预约--插件

预约商品列表

基本信息

Path： /booking/api/goods/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1
cat_id	否	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ name	string	必须
├─ cover_pic	string	必须
├─ id	number	必须
├─ goods_id	number	必须
├─ price	string	必须
├─ price_str	string	必须		价格

预约商品详情

基本信息

Path： /booking/api/goods/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
goods_id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须		可补充
├─ list	object	非必须
├─ attr_group	object []	非必须			item 类型: object
├─ attr_group_id	number	非必须
├─ attr_group_name	string	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ attr	object []	非必须			item 类型: object
├─ id	number	非必须
├─ goods_id	number	非必须
├─ sign_id	string	非必须
├─ stock	number	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	number	非必须
├─ pic_url	string	非必须
├─ is_delete	number	非必须
├─ extra	string	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ member_price_2	number	非必须
├─ price_member	number	非必须
├─ member_price_3	number	非必须
├─ member_price_4	number	非必须
├─ member_price_5	number	非必须
├─ member_price_6	number	非必须
├─ member_price_7	number	非必须
├─ member_price_8	number	非必须
├─ member_price_9	number	非必须
├─ member_price_10	number	非必须
├─ member_price_11	number	非必须
├─ member_price_12	number	非必须
├─ member_price_13	number	非必须
├─ member_price_14	number	非必须
├─ name	string	非必须
├─ pic_url	object []	非必须			item 类型: object
├─ id	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ price	string	非必须
├─ detail	string	非必须
├─ goods_id	number	非必须
├─ store	string []	非必须			item 类型: string
├─		非必须
├─ id	number	非必须

订单预览

基本信息

Path： /booking/api/order/order-preview

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

订单提交

基本信息

Path： /booking/api/order/order-submit

Method： GET

接口描述：

请求参数

分类列表

基本信息

Path： /booking/api/booking/cats

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ cat	object []	非必须		详见cats	item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ parent_id	string	非必须
├─ name	string	非必须
├─ pic_url	string	非必须
├─ sort	string	非必须
├─ big_pic_url	string	非必须
├─ advert_pic	string	非必须
├─ advert_url	string	非必须
├─ status	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须

门店列表

基本信息

Path： /booking/api/booking/store-list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
goods_id	是	商品id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ store	object []	非必须		门店信息	item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ store_id	string	非必须
├─ goods_id	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ store	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ address	string	非必须
├─ longitude	string	非必须
├─ latitude	string	非必须
├─ score	string	非必须
├─ cover_url	string	非必须
├─ pic_url	string	非必须
├─ business_hours	string	非必须
├─ description	string	非必须
├─ is_default	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须

配置详情

基本信息

Path： /plugin/booking/api/booking/setting

Method： GET

接口描述：
undefined

请求参数

预约订单列表

基本信息

Path： /plugin/booking/api/order-list/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1
status	是	0	0全部 1待付款 2待使用 4待评价 5售后

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ mch_id	string	必须
├─ order_no	string	必须
├─ total_price	string	必须
├─ total_pay_price	string	必须
├─ express_original_price	string	必须
├─ express_price	string	必须
├─ total_goods_price	string	必须
├─ total_goods_original_price	string	必须
├─ member_discount_price	string	必须
├─ use_user_coupon_id	string	必须
├─ coupon_discount_price	string	必须
├─ use_integral_num	string	必须
├─ integral_deduction_price	string	必须
├─ name	string	必须
├─ mobile	string	必须
├─ address	string	必须
├─ remark	string	必须
├─ order_form	object	必须
├─ words	string	必须
├─ seller_remark	string	必须
├─ is_pay	string	必须
├─ pay_type	string	必须
├─ pay_time	string	必须
├─ is_send	string	必须
├─ send_time	string	必须
├─ express	string	必须
├─ express_no	string	必须
├─ is_sale	string	必须
├─ is_confirm	string	必须
├─ confirm_time	string	必须
├─ cancel_status	string	必须
├─ cancel_time	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_recycle	string	必须
├─ is_offline	string	必须
├─ offline_qrcode	string	必须
├─ clerk_id	string	必须
├─ store_id	string	必须
├─ sign	string	必须
├─ token	string	必须
├─ support_pay_types	string,null	必须
├─ detail	object []	必须			item 类型: object
├─ id	string	必须
├─ order_id	string	必须
├─ goods_id	string	必须
├─ num	string	必须
├─ unit_price	string	必须
├─ total_original_price	string	必须
├─ total_price	string	必须
├─ member_discount_price	string	必须
├─ goods_info	object	必须
├─ name	string	非必须
├─ num	string	非必须
├─ total_original_price	string	非必须
├─ member_discount_price	string	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	必须
├─ attr_group_id	number	必须
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ pic_url	string	非必须
├─ is_delete	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须

预约订单详情

基本信息

Path： /plugin/booking/api/order-list/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	127	订单id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ mch_id	string	非必须
├─ order_no	string	非必须
├─ total_price	string	非必须
├─ total_pay_price	string	非必须
├─ express_original_price	string	非必须
├─ express_price	string	非必须
├─ total_goods_price	string	非必须
├─ total_goods_original_price	string	非必须
├─ member_discount_price	string	非必须
├─ use_user_coupon_id	string	非必须
├─ coupon_discount_price	string	非必须
├─ use_integral_num	string	非必须
├─ integral_deduction_price	string	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ address	string	非必须
├─ remark	string	非必须
├─ order_form	string	非必须
├─ words	string	非必须
├─ seller_remark	string	非必须
├─ is_pay	string	非必须
├─ pay_type	string	非必须
├─ pay_time	string	非必须
├─ is_send	string	非必须
├─ send_time	string	非必须
├─ express	string	非必须
├─ express_no	string	非必须
├─ is_sale	string	非必须
├─ is_confirm	string	非必须
├─ confirm_time	string	非必须
├─ cancel_status	string	非必须
├─ cancel_time	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_recycle	string	非必须
├─ is_offline	string	非必须
├─ offline_qrcode	string	非必须
├─ clerk_id	string	非必须
├─ store_id	string	非必须
├─ sign	string	非必须
├─ token	string	非必须
├─ support_pay_types	string	非必须
├─ detail	object []	非必须			item 类型: object
├─ id	string	非必须
├─ order_id	string	非必须
├─ goods_id	string	非必须
├─ num	string	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ member_discount_price	string	非必须
├─ goods_info	object	非必须
├─ name	string	非必须
├─ num	string	非必须
├─ total_original_price	string	非必须
├─ member_discount_price	string	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ pic_url	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ price	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ status	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ virtual_sales	string	非必须
├─ is_quick_shop	string	非必须
├─ is_sell_well	string	非必须
├─ is_negotiable	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ sort	string	非必须
├─ mch_sort	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ extra	string	非必须
├─ is_default_services	string	非必须
├─ refund	null	非必须
├─ status_text	string	非必须
├─ pay_type_text	string	非必须
├─ goods_num	number	非必须

预约核销码

基本信息

Path： /plugin/booking/api/order-list/clerk-code

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

预约申请取消

基本信息

Path： /plugin/booking/api/order-list/clerk-code_1557046652082

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	订单id

返回数据

名称	类型	是否必须	默认值	备注	其他信息

拼团--插件

我的拼团列表

基本信息

Path： /plugin/pintuan/api/order/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
pintuan_status	是	0	0.全部

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ end_date_time	string	必须		拼团剩余时间
├─ detail	object []	必须		拼团商品详情	item 类型: object
├─ goods_info	object	必须		订单商品信息
├─ attr_list	object []	非必须		商品规格	item 类型: object
├─ attr_group_name	string	必须
├─ attr_group_id	number	必须
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ name	string	非必须		商品名称
├─ cover_pic	string	非必须		商品缩略图
├─ num	number	必须		购买数量
├─ total_price	string	必须		支付金额
├─ id	number	必须		订单ID
├─ pintuan_order_id	string	必须		拼团订单ID
├─ status	number	必须		拼团状态0.待付款|1.拼团中|2.拼团成功|3.拼团失败|4.未退款
├─ status_cn	string	必须		拼团状态
├─ total_pay_price	string	必须		总支付金额
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

拼团下单

基本信息

Path： /plugin/pintuan/api/order/submit

Method： POST

接口描述：

拼团下单流程

1.拼团单独购买下单走商城下单接口

2.拼团购买下单走此接口，参数在原先接口的参数基础上，增加了pintuan_order_id 和 pintuan_group_id
pintuan_order_id 参与其它团时，需传入拼团订单ID
pintuan_group_id 自己新开团时，需传入拼团组ID

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
form_data	text	是	{"list":[{"mch_id":0,"pintuan_order_id":0,"pintuan_group_id":219,"goods_list":[{"id":38461,"attr":[{"attr_id":1,"attr_group_id":1}],"num":1,"goods_attr_id":84149,"cart_id":0}],"distance":0,"remark":"","order_form":[],"use_integral":0,"user_coupon_id":0}],"address_id":0}	拼团下单

返回数据

名称	类型	是否必须	默认值	备注	其他信息

拼团分类列表

基本信息

Path： /plugin/pintuan/api/goods/cats

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须		分类ID
├─ name	string	必须		分类名称

拼团商品列表

基本信息

Path： /plugin/pintuan/api/goods/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
cat_id	是	0	分类ID 0

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	非必须		商品ID
├─ name	string	非必须		商品名称
├─ cover_pic	string	非必须		商品缩略图
├─ original_price	string	非必须		商品原价
├─ sales	number	非必须		商品销量
├─ vip_card_appoint	object	非必须
├─ discount	null	非必须		会员折扣
├─ is_my_vip_card_goods	number	非必须		登录用户是否享受商品折扣 1是 0否
├─ is_vip_card_user	number	非必须		登录用户是不是会员 1是 0否
├─ price	string	非必须		商品价格（最低拼团价）
├─ goods_stock	number	非必须		商品总库存
├─ level_price	number	非必须		会员价
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

拼团商品详情

基本信息

Path： /plugin/pintuan/api/goods/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	商品ID
group_id	是	0	0.表示单买

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	string	非必须		商品ID
├─ mall_id	string	非必须		商城ID
├─ mch_id	string	非必须		商户ID
├─ goods_warehouse_id	string	非必须		关联商品库ID
├─ status	string	非必须		上架状态：0=下架，1=上架
├─ price	string	非必须		售价
├─ use_attr	string	非必须		是否使用规格：0=不使用，1=使用
├─ attr_groups	string	非必须		商品规格组
├─ goods_stock	string	非必须		商品总库存（规格库存相加）
├─ virtual_sales	string	非必须		已出售量（虚拟销量）
├─ confine_count	string	非必须		购物数量限制
├─ pieces	string	非必须		单品满件包邮
├─ forehead	string	非必须		单口满额包邮
├─ freight_id	string	非必须		运费模板ID
├─ give_integral	string	非必须		赠送积分
├─ give_integral_type	string	非必须		赠送积分类型1.固定值 |2.百分比
├─ forehead_integral	string	非必须		可抵扣积分
├─ forehead_integral_type	string	非必须		可抵扣积分类型1.固定值 |2.百分比
├─ accumulative	string	非必须		允许多件累计折扣
├─ individual_share	string	非必须		是否单独合伙人设置：0=否，1=是
├─ attr_setting_type	string	非必须		合伙人设置类型 0.普通设置|1.详细设置
├─ is_level	string	非必须		是否享受会员价购买
├─ is_level_alone	string	非必须		是否单独设置会员价
├─ share_type	string	非必须		合伙人佣金配比 0--固定金额 1--百分比
├─ sign	string	非必须		商品标示用于区分商品属于什么模块
├─ app_share_pic	string	非必须		商品自定义分享图片
├─ app_share_title	string	非必须		商品自定义分享标题
├─ attr	object []	非必须			item 类型: object
├─ id	string	必须
├─ goods_id	string	必须		商品ID
├─ sign_id	string	必须		规格票房
├─ stock	string	必须		库存
├─ price	string	必须		价格
├─ no	string	必须		货号
├─ weight	string	必须		重量
├─ pic_url	string	必须		图片
├─ is_delete	string	必须
├─ extra	string	必须		额外字段
├─ share	object	必须
├─ id	string	非必须
├─ share_commission_first	string	非必须		一级合伙人金额
├─ share_commission_second	string	非必须		二级
├─ share_commission_third	string	非必须		三级
├─ goods_id	string	非必须		商品ID
├─ goods_attr_id	string	非必须		规格ID
├─ is_delete	string	非必须
├─ attr_list	object []	必须		规格组	item 类型: object
├─ attr_group_name	string	必须		规格组名称
├─ attr_group_id	number	必须		规格组ID
├─ attr_id	number	必须		规格ID
├─ attr_name	string	必须		规格名称
├─ member_price_2	string	必须		会员价
├─ price_member	string	必须		当前会员价格
├─ member_price_3	string	必须		会员价
├─ member_price_4	string	必须		会员价
├─ member_price_5	string	必须
├─ member_price_7	string	必须
├─ member_price_8	string	必须
├─ member_price_10	string	必须
├─ member_price_11	string	必须
├─ member_price_12	string	必须
├─ member_price_13	string	必须
├─ member_price_14	string	必须
├─ share	number	非必须
├─ cards	string []	非必须		卡券	item 类型: string
├─		非必须
├─ services	string []	非必须		商品服务	item 类型: string
├─		非必须
├─ pintuanGoods	object	非必须		拼团商品信息
├─ id	string	非必须
├─ is_alone_buy	string	非必须		是否允许单独购买
├─ mall_id	string	非必须
├─ goods_id	string	非必须
├─ end_time	string	非必须		拼团结束时间
├─ groups_restrictions	string	非必须		拼团次数限制
├─ buy_num_restrictions	string	非必须		购买数量限制
├─ is_delete	string	非必须
├─ pintuan_groups	object []	非必须		拼团组信息	item 类型: object
├─ id	string	非必须
├─ goods_id	string	非必须		商品ID
├─ people_num	string	非必须		拼团所需总人数
├─ preferential_price	string	非必须		团长优惠
├─ pintuan_time	string	非必须		拼团限时
├─ goods_num	number	非必须		商品库存
├─ goods_no	string	非必须		商品货号
├─ goods_weight	string	非必须		商品重量
├─ price_min	number	非必须		规格最小价
├─ price_max	number	非必须		规格最大价
├─ sales	number	非必须
├─ advertisement	object []	非必须			item 类型: object
├─ pic_url	string	必须
├─ link_url	string	必须

拼团详情

基本信息

Path： /plugin/pintuan/api/order/pintuan-detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	拼团组ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	number	非必须		拼团订单ID
├─ status	number	非必须		拼团订单状态0.待付款|1.拼团中|2.拼团成功|3.拼团失败|4.未退款
├─ status_cn	string	非必须		拼团订单状态
├─ goods_name	string	非必须		商品名称
├─ goods_cover_pic	string	非必须		商品缩略图
├─ original_price	string	非必须		商品原价
├─ people_num	number	非必须		拼团所需总人数
├─ is_parent	number	非必须		是否为团长0.否|1.是
├─ group_users	object []	非必须		拼团用户列表	item 类型: object
├─ id	number	非必须		关联ID
├─ nickname	string	非必须		用户昵称
├─ avatar	string	非必须		用户头像
├─ price	number	非必须		拼团价（拼团最低价）
├─ group_economize_price	string	非必须		拼团省价
├─ surplus_people	number	非必须		拼团剩余人数
├─ surplus_date_time	string	非必须		拼团结束时间

拼团首页

基本信息

Path： /plugin/pintuan/api/index/index

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ banners	object []	非必须			item 类型: object
├─ id	string	必须		ID
├─ mall_id	string	必须		商城ID
├─ pic_url	string	必须		图片
├─ title	string	必须		标题
├─ page_url	string	必须		小程序页面路径
├─ open_type	string	必须		打开方式:redirect 重定向跳转|navigate普通跳转|app 跳转小程序|contact 客服| clear_cache 清除缓存| tel 拔打电话|web 跳转网页
├─ params	string	必须		导航参数
├─ is_delete	string	必须
├─ created_at	string	必须
├─ deleted_at	string	必须
├─ updated_at	string	必须
├─ setting	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须		商城ID
├─ is_share	number	非必须		是否开启合伙人 0.否|1.是
├─ is_sms	number	非必须		是否短信提醒0.否|1.是
├─ is_mail	number	非必须		是否开启邮件通知0.否|1.是
├─ is_print	number	非必须		是否开启订单打印0.否|1.是
├─ rules	object []	非必须		拼团规则	item 类型: object
├─ title	string	非必须		规则标题
├─ content	string	非必须		规则内容
├─ is_territorial_limitation	number	非必须		是否开启区域允许购买
├─ advertisement	object	非必须		拼团广告
├─ current_style_id	string	非必须		广告样式ID
├─ type	string	非必须
├─ list	object []	非必须		广告样式参数	item 类型: object
├─ pic_url	string	非必须
├─ link_url	string	非必须
├─ style	string	非必须
├─ width	string	非必须
├─ height	string	非必须
├─ top	string	非必须
├─ left	string	非必须
├─ open_type	string	非必须
├─ is_advertisement	number	非必须		是否开启拼团广告0.否|1.是
├─ created_at	string	非必须
├─ payment_type	string []	非必须		支付方式	item 类型: string
├─		非必须
├─ send_type	string []	非必须		发货方式	item 类型: string
├─		非必须
├─ goods_poster	object	非必须		拼团海报
├─ bg_pic	object	非必须		背景图
├─ url	string	非必须
├─ pic	object	非必须		商品图
├─ is_show	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_type	string	非必须
├─ head	object	非必须		商品名称
├─ is_show	number	非必须
├─ size	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_type	string	非必须
├─ nickname	object	非必须		用户昵称
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ nickname_share	object	非必须		合伙人昵称
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ poster_bg	object	非必须
├─ is_show	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_path	string	非必须
├─ file_type	string	非必须
├─ qr_code	object	非必须		二维码
├─ is_show	number	非必须
├─ size	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ type	number	非必须
├─ file_path	string	非必须
├─ file_type	string	非必须
├─ name	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ desc	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ width	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ price	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ color	string	非必须
├─ text	string	非必须
├─ file_type	string	非必须

秒杀--插件

秒杀商品分类列表（未使用）

基本信息

Path： /plugin/miaosha/api/goods/cats

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ parent_id	string	必须
├─ name	string	必须		分类名称
├─ pic_url	string	必须		分类图标
├─ sort	string	必须		排序
├─ big_pic_url	string	必须
├─ advert_pic	string	必须
├─ advert_url	string	必须
├─ status	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

今日秒杀（未使用）

基本信息

Path： /miaosha/api/goods/today-miaosha

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
cat_id	是	0	0.全部

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	array []	非必须			item 类型: array
├─		非必须
├─		非必须
├─ surplus_d_time	number	非必须		当天剩余秒数
├─ surplus_h_time	number	非必须		当前整点剩余秒数

商品详情

基本信息

Path： /plugin/miaosha/api/goods/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	秒杀商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	string	非必须		商品ID
├─ mall_id	string	非必须		商城ID
├─ mch_id	string	非必须		商户ID
├─ goods_warehouse_id	string	非必须		关联商品库ID
├─ status	string	非必须		上架状态：0=下架，1=上架
├─ price	string	非必须		售价
├─ use_attr	string	非必须		是否使用规格：0=不使用，1=使用
├─ attr_groups	string	非必须		商品规格组
├─ goods_stock	string	非必须		商品总库存（规格库存相加）
├─ virtual_sales	string	非必须		已出售量（虚拟销量）
├─ confine_count	string	非必须		购物数量限制
├─ pieces	string	非必须		单品满件包邮
├─ forehead	string	非必须		单口满额包邮
├─ freight_id	string	非必须		运费模板ID
├─ give_integral	string	非必须		赠送积分
├─ give_integral_type	string	非必须		赠送积分类型1.固定值 |2.百分比
├─ forehead_integral	string	非必须		可抵扣积分
├─ forehead_integral_type	string	非必须		可抵扣积分类型1.固定值 |2.百分比
├─ accumulative	string	非必须		允许多件累计折扣
├─ individual_share	string	非必须		是否单独合伙人设置：0=否，1=是
├─ attr_setting_type	string	非必须		合伙人设置类型 0.普通设置|1.详细设置
├─ is_level	string	非必须		是否享受会员价购买
├─ is_level_alone	string	非必须		是否单独设置会员价
├─ share_type	string	非必须		合伙人佣金配比 0--固定金额 1--百分比
├─ sign	string	非必须		商品标示用于区分商品属于什么模块
├─ app_share_pic	string	非必须		商品自定义分享图片
├─ app_share_title	string	非必须		商品自定义分享标题
├─ is_default_services	string	非必须		默认服务 0.否|1.是
├─ sort	string	非必须		商品排序
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须		统计 支付人数
├─ payment_num	string	非必须		统计 支付件数
├─ payment_amount	string	非必须		统计 支付金额
├─ payment_order	string	非必须		支付订单数
├─ confine_order_count	string	非必须		限制下单数量
├─ is_area_limit	string	非必须		是否单独区域购买
├─ area_limit	string	非必须		区域限制详情 json格式
├─ share_level_type	string	非必须		合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_id	string	非必须		自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ name	string	非必须		商品名称
├─ original_price	string	非必须		商品原价
├─ cover_pic	string	非必须		商品缩略图
├─ unit	string	非必须		商品单位
├─ detail	string	非必须		商品详情
├─ video_url	string	非必须		商品视频
├─ level_show	number	非必须		会员等级是否显示0.否|1.是
├─ is_sales	number	非必须		是否售后
├─ attr	object []	非必须		商品规格	item 类型: object
├─ id	number	必须		规格ID
├─ goods_id	number	必须		商品ID
├─ sign_id	string	必须		规格组合，关联规格组
├─ stock	number	必须		库存
├─ price	string	必须		规格价
├─ no	string	必须		商品货号
├─ weight	number	必须		商品重量
├─ pic_url	string	必须		商品轮播图
├─ is_delete	number	必须
├─ attr_list	object []	必须		规格组信息	item 类型: object
├─ attr_group_name	string	必须		规格组名
├─ attr_group_id	number	必须		规格组ID
├─ attr_id	number	必须		规格ID
├─ attr_name	string	必须		规格名称
├─ price_member	number	必须		会员价
├─ member_price_list	object []	必须			item 类型: object
├─ id	number	必须
├─ level	number	必须
├─ price	string	必须
├─ goods_attr_id	number	必须
├─ is_delete	number	必须
├─ goods_id	number	必须
├─ member_price_2	number	必须
├─ member_price_3	number	必须
├─ goods_num	number	非必须		商品库存
├─ goods_no	string	非必须		商品货号
├─ goods_weight	number	非必须		商品重量
├─ services	string []	非必须		商品服务	item 类型: string
├─		非必须
├─ cards	string []	非必须		商品卡券	item 类型: string
├─		非必须
├─ price_min	number	非必须		规格最小价
├─ price_max	number	非必须		规格最大价
├─ pic_url	object []	非必须		商品轮播图	item 类型: object
├─ id	string	必须
├─ pic_url	string	必须
├─ share	number	非必须
├─ sales	number	非必须
├─ favorite	boolean	非必须
├─ goods_marketing	object	非必须
├─ limit	string	非必须
├─ pickup	string	非必须
├─ shipping	string	非必须
├─ goods_marketing_award	object	非必须
├─ card	object	非必须
├─ title	string	非必须
├─ list	string []	非必须			item 类型: string
├─		非必须
├─ integral	object	非必须
├─ title	string	非必须
├─ vip_card_appoint	object	非必须
├─ discount	null	非必须
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ price_member_max	number	非必须
├─ price_member_min	number	非必须
├─ miaoshaGoods	object	非必须
├─ id	number	非必须		ID
├─ mall_id	number	非必须		商城ID
├─ goods_id	number	非必须		商品ID
├─ goods_warehouse_id	number	非必须		商品库ID
├─ open_time	number	非必须		开放时间
├─ open_date	string	非必须		开放日期
├─ buy_limit	number	非必须		限单 -1|不限单
├─ virtual_miaosha_num	number	非必须		虚拟秒杀量
├─ is_delete	string	非必须
├─ miaosha_status	number	非必须		秒杀状态：0.已结束|1.正在进行中|2.未开始
├─ miaosha_time	number	非必须		秒杀剩余时间（单位：秒）
├─ miaosha_buy_count	number	非必须		已被抢购总数（包含虚拟销量）

整点秒杀商品列表

基本信息

Path： /plugin/miaosha/api/goods/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
open_date	是	2019-04-05	秒杀日期
open_time	是	1	秒杀时间
type	是	1	1.整点商品2.秒杀预告商品

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	非必须		ID
├─ mall_id	number	非必须		商城ID
├─ goods_id	number	非必须		商品ID
├─ goods_warehouse_id	number	非必须		商品库ID
├─ open_time	number	非必须		开放时间
├─ open_date	string	非必须		开放日期
├─ buy_limit	number	非必须		限单 -1|不限单
├─ virtual_miaosha_num	number	非必须		虚拟秒杀量
├─ is_delete	number	非必须
├─ min_price	string	非必须		商品规格最小价
├─ miaosha_count	number	非必须		已秒杀数量
├─ miaosha_num	number	非必须		当前秒杀商品库存
├─ miaosha_percentage	string	非必须		已秒杀百分比
├─ is_level	number	非必须		是否显示会员价
├─ level_price	number	非必须		会员价格
├─ goods	object	非必须
├─ id	number	非必须		ID
├─ mall_id	number	非必须		商城ID
├─ goods_id	number	非必须		商品ID
├─ goods_warehouse_id	number	非必须		商品库ID
├─ open_time	number	非必须		开放时间
├─ open_date	string	非必须		开放日期
├─ buy_limit	number	非必须		限单 -1|不限单
├─ virtual_miaosha_num	number	非必须		虚拟秒杀量
├─ is_delete	number	非必须
├─ min_price	string	非必须		商品规格最小价
├─ miaosha_count	number	非必须		已秒杀数量
├─ miaosha_num	number	非必须		当前秒杀商品库存
├─ miaosha_percentage	string	非必须		已秒杀百分比
├─ is_level	number	非必须		是否显示会员价
├─ level_price	number	非必须		会员价格
├─ name	string	非必须		商品名称
├─ original_price	string	非必须		商品原价
├─ cost_price	string	非必须		成本价
├─ detail	string	非必须		商品详情
├─ cover_pic	string	非必须		商品缩略图
├─ pic_url	string	非必须		商品轮播衅
├─ video_url	string	非必须		商品视频
├─ unit	string	非必须		商品单位
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ vip_card_appoint	object	非必须		超级会员卡优惠
├─ discount	null	非必须		优惠折扣
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

正在进行|即将开始 秒杀列表（未使用）

基本信息

Path： /miaosha/api/goods/miaosha

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
type	是	1	1.正在秒杀(默认) 2.即将开始
cat_id	是	0	0.全部

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ goods_id	string	非必须		商城商品ID
├─ open_time	string	非必须		开始时间
├─ open_date	string	非必须		开始日期
├─ buy_limit	string	非必须		限单 -1|不限单
├─ confine_count	string	非必须		购物数量限制
├─ pieces	string	非必须		单品满件包邮
├─ forehead	string	非必须		单口满额包邮
├─ freight_id	string	非必须		运费模版ID
├─ give_integral	string	非必须		赠送积分
├─ give_integral_type	string	非必须		赠送积分类型1.固定值 |2.百分比
├─ forehead_integral	string	非必须		可抵扣积分
├─ forehead_integral_type	string	非必须		可抵扣积分类型1.固定值 |2.百分比
├─ accumulative	string	非必须		允许多件累计折扣
├─ individual_share	string	非必须		是否单独合伙人设置：0=否，1=是
├─ attr_setting_type	string	非必须		合伙人设置类型 0.普通设置|1.详细设置
├─ is_level	string	非必须		是否享受会员价购买
├─ is_level_alone	string	非必须		是否享受会员价购买
├─ share_type	string	非必须		佣金配比 0--固定金额 1--百分比
├─ app_share_pic	string	非必须		自定义分享图片
├─ app_share_title	string	非必须		自定义分享标题
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ goods	object	非必须		商城商品信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ price	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ status	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ virtual_sales	string	非必须
├─ is_quick_shop	string	非必须
├─ is_sell_well	string	非必须
├─ is_negotiable	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ sort	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ extra	null	非必须
├─ is_default_services	string	非必须
├─ attr	object []	非必须		秒杀商品规格	item 类型: object
├─ id	string	必须
├─ goods_attr_id	string	必须		商城商品规格ID
├─ miaosha_price	string	必须		秒杀价
├─ miaosha_stock	string	必须		秒杀库存
├─ miaosha_goods_id	string	必须		秒杀商品ID
├─ min_price	string	非必须		显示最小价
├─ miaosha_count	number	非必须		已秒杀数量
├─ miaosha_num	number	非必须		秒杀总数
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

加入购物车

基本信息

Path： /miaosha/api/index/add-cart

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
miaosha_goods_id	text	是	149	秒杀商品ID
attr_id	text	是	1	秒杀规格ID
num	text	是	1	数量

返回数据

名称	类型	是否必须	默认值	备注	其他信息

秒杀整点时间段列表

基本信息

Path： /miaosha/api/goods/time-list

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ open_time	string	必须		整点开始时间
├─ new_open_time	string	必须		整点开始时间（时间格式）
├─ label	string	必须		活动状态（中文）
├─ status	number	必须		status
├─ time	number	必须		剩余时间（单位：秒）
├─ date_time	string	必须		整点开始时间
├─ is_estimate	number	非必须		是否秒杀商品预告0.否|1.是
├─ next_miaosha_date_time	string	非必须		下一场秒杀开始日期时间

秒杀订单提交（参数与商城相同）

基本信息

Path： /plugin/miaosha/api/order/submit

Method： GET

接口描述：

请求参数

秒杀订单预览（参数与商城相同）

基本信息

Path： /plugin/miaosha/api/order/order-preview

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

秒杀首页

基本信息

Path： /plugin/miaosha/api/index/index

Method： GET

接口描述：

跳转方式参数说明

app跳转
    app_id    跳转小程序的appID
    path    跳转的小程序页面

tel 跳转
    tel    联系电话

web 跳转
    url    跳转网页路径

contact 跳转~~~~

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ banners	object []	非必须		首页轮播图	item 类型: object
├─ id	string	非必须		ID
├─ mall_id	string	非必须		商城ID
├─ pic_url	string	非必须		图片
├─ title	string	非必须		标题
├─ page_url	string	非必须		小程序页面路径
├─ open_type	string	非必须		打开方式:redirect 重定向跳转|navigate普通跳转|app 跳转小程序|contact 客服| clear_cache 清除缓存| tel 拔打电话|web 跳转网页
├─ params	string	非必须		导航参数
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ updated_at	string	非必须
├─ setting	object	非必须
├─ id	number	非必须		ID
├─ mall_id	number	非必须		商城ID
├─ over_time	number	非必须		未支付订单取消时间
├─ is_share	number	非必须		是否开启合伙人 0.否|1.是
├─ is_sms	number	非必须		是否短信提醒0.否|1.是
├─ is_mail	number	非必须		是否开启邮件通知0.否|1.是
├─ is_print	number	非必须		是否开启订单打印0.否|1.是
├─ is_territorial_limitation	number	非必须		区域购买限制0.否|1.是
├─ open_time	string []	非必须		秒杀开放时间	item 类型: string
├─		非必须
├─ created_at	string	非必须
├─ payment_type	string []	非必须		支付方式	item 类型: string
├─		非必须
├─ send_type	string []	非必须			item 类型: string
├─		非必须
├─ goods_poster	object	非必须		秒杀自定义海报
├─ bg_pic	object	非必须		背景图
├─ url	string	非必须
├─ pic	object	非必须		商品图
├─ is_show	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_type	string	非必须
├─ head	object	非必须		头像
├─ is_show	number	非必须
├─ size	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_type	string	非必须
├─ nickname	object	非必须		用户昵称
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ nickname_share	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ poster_bg	object	非必须		标识
├─ is_show	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_path	string	非必须
├─ file_type	string	非必须
├─ poster_time	object	非必须
├─ is_show	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_path	string	非必须
├─ file_type	string	非必须
├─ time_str	object	非必须		时间
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ qr_code	object	非必须		二维码
├─ is_show	number	非必须
├─ size	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ type	number	非必须
├─ file_path	string	非必须
├─ file_type	string	非必须
├─ name	object	非必须		商品名称
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ desc	object	非必须		描述
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ width	number	非必须
├─ price	object	非必须		商品价格
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ color	string	非必须
├─ text	string	非必须
├─ file_type	string	非必须

购物车编辑

基本信息

Path： /miaosha/api/index/cart-edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
list	text	是		和商城一样

返回数据

名称	类型	是否必须	默认值	备注	其他信息

DIY装修API

页面详情

基本信息

Path： /plugin/diy/api/page/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	页面id

返回数据

名称	类型	是否必须	默认值	备注	其他信息

多商户

修改订单总价

基本信息

Path： /plugin/mch/api/order/update-total-price

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
total_price	text	是	10	价格
mch_id	text	是	1	多商户ID
order_id	text	是	1	订单ID
express_price	text	是	1	运费

返回数据

名称	类型	是否必须	默认值	备注	其他信息

资产首页

基本信息

Path： /plugin/mch/api/property/index

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
mch_id	是	10	多商户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ account_money	string	非必须		可提现余额
├─ transfer_rate	number	非必须		手续费
├─ close_money	number	非必须		结算金额
├─ not_close_money	number	非必须		未结算金额

单商品修改价格

基本信息

Path： /plugin/mch/api/order/update-price

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
total_price	text	是	10	价格
mch_id	text	是	1	多商户ID
order_detail_id	text	是	1	订单详情ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

售后订单详情

基本信息

Path： /plugin/mch/api/order/refund-detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	18	售后订单ID
mch_id	是	10	商户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	number	非必须		售后订单ID
├─ mall_id	number	非必须		商城ID
├─ mch_id	number	非必须		商户ID
├─ user_id	number	非必须		用户ID
├─ order_id	number	非必须		关联订单ID
├─ order_detail_id	number	非必须		关联订单详情ID
├─ order_no	string	非必须		售后订单号
├─ type	number	非必须		售后类型：1=退货退款，2=换货
├─ refund_price	string	非必须		退款金额
├─ remark	string	非必须		用户退款备注、说明
├─ pic_list	string	非必须		用户上传图片凭证
├─ status	number	非必须		订单状态 1.待商家处理 2.同意 3.拒绝
├─ status_time	string	非必须		商家处理时间
├─ merchant_remark	string	非必须		商家同意|拒绝备注、理由
├─ is_send	number	非必须		用户是否发货 0.未发货1.已发货
├─ send_time	string	非必须		发货时间
├─ customer_name	string	非必须		京东商家编号
├─ express	string	非必须		快递公司
├─ express_no	string	非必须		快递单号
├─ address_id	number	非必须		退换货地址ID
├─ is_confirm	number	非必须		商家是否确认操作0.未确认|1.已确认
├─ confirm_time	string	非必须		确认时间
├─ is_refund	number	非必须		退货退款时，是否退款
├─ refund_time	string	非必须		退款时间
├─ merchant_customer_name	string	非必须		换货-商家京东商家编号
├─ merchant_express	string	非必须		换货-商家发货快递公司
├─ merchant_express_no	string	非必须		换货-商家发货快递单号
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ status_text	string	非必须		售后订单状态（中文）
├─ detail	object []	非必须			item 类型: object
├─ id	number	非必须		商品详情ID
├─ order_id	number	非必须		关联订单ID
├─ goods_id	number	非必须		商品ID
├─ num	number	非必须		商品数量
├─ unit_price	string	非必须		商品单价
├─ total_original_price	string	非必须		商品原总价(优惠前)
├─ total_price	string	非必须		商品总价(优惠后)
├─ member_discount_price	string	非必须		会员优惠金额(正数表示优惠，负数表示加价)
├─ goods_info	object	非必须		商品信息josn格式
├─ name	string	非必须		商品名称
├─ attr_list	object []	非必须		已选规格信息	item 类型: object
├─ attr_group_name	string	必须		规格组名
├─ attr_group_id	number	必须		规格组ID
├─ attr_id	number	必须		规格ID
├─ attr_name	string	必须		规格名称
├─ pic_url	string	非必须		商品缩略图
├─ num	number	非必须		商品数量
├─ total_original_price	string	非必须		商品总价（优惠前）
├─ member_discount_price	string	非必须		会员折扣金额
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_refund	number	非必须		商品是否退款
├─ refund_status	number	非必须		售后状态 0--未售后 1--售后中 2--售后结束
├─ back_price	string	非必须		售后状态 0--未售后 1--售后中 2--售后结束
├─ sign	string	非必须		订单详情标识，用于区分插件
├─ goods_no	string	非必须		商品货号
├─ order	object	非必须
├─ name	string	非必须		收件人
├─ mobile	string	非必须		收件人电话
├─ address	string	非必须		收件人地址
├─ express_list	object []	非必须		快递公司列表	item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ code	string	必须
├─ address	string []	非必须		完整收件人地址	item 类型: string
├─		非必须

订单同意|拒绝取消

基本信息

Path： /plugin/mch/api/order/cancel

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
mch_id	text	是	10	多商户ID
order_id	text	是	1	商品ID
remark	text	是		同意
status	text	是		1.同意

返回数据

名称	类型	是否必须	默认值	备注	其他信息

订单发货

基本信息

Path： /api/order/order-send

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
order_id	text	是	152	订单ID
mch_id	text	是	10	多商户ID
express	text	是	顺丰速运
express_no	text	是	218371209380918
words	text	否	备注
is_express	text	是		是否快递发货0.否

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取面单

基本信息

Path： /plugin/mch/api/order/print

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
order_id	是	1	订单ID
express	是	顺丰速运	快递公司
mch_id	是	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息

结算记录

基本信息

Path： /plugin/mch/api/property/order-close-log

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
mch_id	是	10
is_transfer	是	0	0.未结算

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mchOrder	object	必须
├─ id	string	非必须
├─ order_id	string	非必须		订单ID
├─ is_transfer	string	非必须		是否转入商户0.否|1.是
├─ updated_at	string	非必须
├─ detail	object []	必须			item 类型: object
├─ id	number	必须		商品详情ID
├─ order_id	number	必须		关联订单ID
├─ goods_id	number	必须		商品ID
├─ num	number	必须		商品数量
├─ unit_price	string	必须		商品单价
├─ total_original_price	string	必须		商品原总价(优惠前)
├─ total_price	string	必须		商品总价(优惠后)
├─ member_discount_price	string	必须		会员优惠金额(正数表示优惠，负数表示加价)
├─ goods_info	object	必须		商品信息josn格式
├─ name	string	非必须		商品名称
├─ attr_list	object []	非必须		已选规格信息	item 类型: object
├─ attr_group_name	string	必须		规格组名
├─ attr_group_id	number	必须		规格组ID
├─ attr_id	number	必须		规格ID
├─ attr_name	string	必须		规格名称
├─ pic_url	string	非必须		商品缩略图
├─ num	number	非必须		商品数量
├─ total_original_price	string	非必须		商品总价（优惠前）
├─ member_discount_price	string	非必须		会员折扣金额
├─ is_delete	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ goods	object	必须
├─ id	string	非必须		商品ID
├─ mall_id	string	非必须		商城ID
├─ mch_id	string	非必须		商户ID
├─ name	string	非必须
├─ price	string	非必须		售价
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ goods_warehouse_id	string	非必须		关联商品库ID
├─ status	string	非必须		上架状态：0=下架，1=上架
├─ use_attr	string	非必须		是否使用规格：0=不使用，1=使用
├─ attr_groups	string	非必须		商品规格组
├─ goods_stock	string	非必须		商品总库存（规格库存相加）
├─ virtual_sales	string	非必须		已出售量（虚拟销量）
├─ confine_count	string	非必须		购物数量限制
├─ pieces	string	非必须		单品满件包邮
├─ forehead	string	非必须		单口满额包邮
├─ freight_id	string	非必须		运费模板ID
├─ give_integral	string	非必须		赠送积分
├─ give_integral_type	string	非必须		赠送积分类型1.固定值 |2.百分比
├─ forehead_integral	string	非必须		可抵扣积分
├─ forehead_integral_type	string	非必须		可抵扣积分类型1.固定值 |2.百分比
├─ accumulative	string	非必须		允许多件累计折扣
├─ individual_share	string	非必须		是否单独合伙人设置：0=否，1=是
├─ attr_setting_type	string	非必须		合伙人设置类型 0.普通设置|1.详细设置
├─ is_level	string	非必须		是否享受会员价购买
├─ is_level_alone	string	非必须		是否单独设置会员价
├─ share_type	string	非必须		合伙人佣金配比 0--固定金额 1--百分比
├─ sign	string	非必须		商品标示用于区分商品属于什么模块
├─ app_share_pic	string	非必须		商品自定义分享图片
├─ app_share_title	string	非必须		商品自定义分享标题
├─ extra	string	非必须		其它插件o数据
├─ is_default_services	string	非必须		是不否为
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

商品申请上架

基本信息

Path： /plugin/mch/api/goods/apply-status

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
mch_id	text	是	1	备注
id	text	是	1	商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

收支记录

基本信息

Path： /plugin/mch/api/property/account-log

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
mch_id	是	10

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须		商城ID
├─ mch_id	string	必须		商户ID
├─ money	string	必须		金额
├─ desc	string	必须		备注说明
├─ type	string	必须		类型：1=收入，2=支出
├─ created_at	string	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

提现记录

基本信息

Path： /plugin/mch/api/property/cash-log

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
mch_id	是	10

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须		提现ID
├─ mall_id	string	必须		商城ID
├─ mch_id	string	必须		多商户ID
├─ money	string	必须		提现金额
├─ order_no	string	必须		提现订单号
├─ status	string	必须		提现状态：0=待处理，1=同意，2=拒绝
├─ type	string	必须		wx 微信| alipay 支付宝 | bank 银行卡 | balance 余额
├─ type_data	string	必须		不同提现类型，提交的数据
├─ virtual_type	string	必须		后台实际上打款方式
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

商家售后处理

基本信息

Path： /plugin/mch/api/order/refund-handle

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
mch_id	text	是	1
order_refund_id	text	是	1	售后订单ID
merchant_remark	text	是	备注	商家备注
is_agree	text	是	1	商家是否同意0.拒绝
address_id	text	是	1	退换货地址ID
type	text	是	1	售后类型 1退货 2 换货
refund_price	text	是	10	退款金额
express	text	是	顺丰速运	快递公司
express_no	text	是		快递单号
is_express	text	是		是否快递发货0.否

返回数据

名称	类型	是否必须	默认值	备注	其他信息

提现申请

基本信息

Path： /plugin/mch/api/property/cash-submit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
mch_id	text	是	1	商户ID
type	text	是	wx	提现类型: wx 微信线下转账
type_data	text	是		提现类型数据
money	text	是		提现金额

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ status	string	非必须		是否营业0.否|1.是
├─ is_recommend	string	非必须		好店推荐：0.不推荐|1.推荐
├─ review_status	string	非必须		审核状态：0=待审核，1.审核通过.2=审核不通过
├─ review_remark	string	非必须		审核结果、备注
├─ review_time	string	非必须		审核时间
├─ realname	string	非必须		真实姓名
├─ wechat	string	非必须		真实姓名
├─ mobile	string	非必须		手机号码
├─ mch_common_cat_id	string	非必须
├─ transfer_rate	string	非必须		商户手续费
├─ account_money	string	非必须		账户余额
├─ sort	string	非必须		店铺排序|升序
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ user	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ store_id	string	非必须
├─ platform	string	非必须
├─ store	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ address	string	非必须
├─ longitude	string	非必须
├─ latitude	string	非必须
├─ score	string	非必须
├─ cover_url	string	非必须
├─ pic_url	string	非必须
├─ business_hours	string	非必须
├─ description	string	非必须
├─ scope	string	非必须
├─ is_default	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

快递公司列表

基本信息

Path： /api/express/express-list

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须		ID
├─ name	string	必须		物流公司名称
├─ code	string	必须		物流编码

多商户入驻申请

基本信息

Path： /plugin/mch/api/mch/apply

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	1	多商户ID
realname	text	是	wxf	真实姓名
wechat	text	是	wechat	微信号
mobile	text	是	手机号	手机号
address	text	是	浙江省嘉兴市	地址
mch_common_cat_id	text	是	1	多商户类目ID1
name	text	是	wxf	店铺名称
logo	text	是		店铺头像
bg_pic_url	text	是	[]	背景图(数组对象格式)
service_mobile	text	是	123456	客服电话
province_id	text	是	1	省ID
city_id	text	是	1	市ID
district_id	text	是	1	区ID
username	text	是		商户账号
password	text	是		商户密码
form_data	text	是		自定义表单
is_update_apply	text	是	1	重新提交审核时使用

返回数据

名称	类型	是否必须	默认值	备注	其他信息

多商户列表

基本信息

Path： /plugin/mch/api/mch/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1	分页
keyword	否	小二	店铺名称
mch_common_cat_id	否	1	类目ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须		店铺ID
├─ mall_id	string	非必须		商城ID
├─ user_id	string	非必须		用户ID
├─ status	string	非必须		是否营业0.否|1.是
├─ is_recommend	string	非必须		好店推荐：0.不推荐|1.推荐
├─ review_status	string	非必须		审核状态：0=待审核，1.审核通过.2=审核不通过
├─ review_remark	string	非必须		审核结果、备注
├─ review_time	string	非必须		审核时间
├─ realname	string	非必须		真实姓名
├─ wechat	string	非必须		真实姓名
├─ mobile	string	非必须		手机号码
├─ mch_common_cat_id	string	非必须		商户所属类目ID
├─ transfer_rate	string	非必须		商户手续费
├─ account_money	string	非必须		账户余额
├─ sort	string	非必须		店铺排序|升序
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ user	object	非必须
├─ id	string	非必须		用户ID
├─ mall_id	string	非必须		商城ID
├─ mch_id	string	非必须		商户ID
├─ username	string	非必须		用户名
├─ password	string	非必须		密码
├─ nickname	string	非必须		用户昵称
├─ auth_key	string	非必须		授权key
├─ access_token	string	非必须		token
├─ mobile	string	非必须		手机号
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须		用户ID
├─ avatar	string	非必须		头像
├─ platform_user_id	string	非必须		用户所属平台的用户id
├─ integral	string	非必须		剩余积分
├─ total_integral	string	非必须		最高积分
├─ balance	string	非必须		余额
├─ total_balance	string	非必须		总余额
├─ parent_id	string	非必须		上级id
├─ is_blacklist	string	非必须		是否黑名单
├─ contact_way	string	非必须		联系方式
├─ remark	string	非必须		备注
├─ is_delete	string	非必须
├─ junior_at	string	非必须		成为下级时间
├─ platform	string	非必须		用户所属平台标识
├─ temp_parent_id	string	非必须		临时上级
├─ store	object	非必须		商户店铺信息
├─ id	string	非必须		店铺ID
├─ mall_id	string	非必须		商城Id
├─ mch_id	string	非必须		商户ID
├─ name	string	非必须		店铺名称
├─ mobile	string	非必须		联系方式
├─ address	string	非必须		店铺地址
├─ longitude	string	非必须		店铺经度
├─ latitude	string	非必须		店铺纬度
├─ score	string	非必须		店铺评分
├─ cover_url	string	非必须		店铺封面图
├─ pic_url	string	非必须		门店轮播图
├─ business_hours	string	非必须		营业时间
├─ description	string	非必须		门店描述
├─ is_default	string	非必须		默认总店0.否|1.是
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

多商户更新密码

基本信息

Path： /plugin/mch/api/mch/update-password

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
mch_id	text	是	1	多商户ID
password	text	是		新密码

返回数据

名称	类型	是否必须	默认值	备注	其他信息

多商户状态

基本信息

Path： /plugin/mch/api/mch/mch-status

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ mch	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须		商城ID
├─ user_id	number	非必须		用户ID
├─ status	number	非必须		是否营业0.否|1.是
├─ is_recommend	number	非必须		好店推荐：0.不推荐|1.推荐
├─ review_status	number	非必须		审核状态：0=待审核，1.审核通过.2=审核不通过
├─ review_remark	string	非必须		审核结果、备注
├─ review_time	string	非必须		审核时间
├─ realname	string	非必须		真实姓名
├─ wechat	string	非必须		微信号
├─ mobile	string	非必须		手机号码
├─ mch_common_cat_id	number	非必须		商户所属类目
├─ transfer_rate	number	非必须		商户手续费
├─ account_money	string	非必须		账户余额
├─ sort	number	非必须		店铺排序|升序
├─ form_data	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ token	string	非必须

店铺统计年份列表

基本信息

Path： /plugin/mch/api/mch/year-list

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ year_list	object []	非必须		年份列表	item 类型: object
├─ year	number	必须		年
├─ month_list	object []	必须			item 类型: object
├─ month	number	必须		月
├─ name_en	string	必须		月份（英文）
├─ name_cn	string	必须		月份（中文）
├─ active	boolean	必须		是否选中
├─ active	boolean	必须		是否选中
├─ current_year	number	非必须		当前年份
├─ current_month	number	非必须		当前月份

多商户账号密码登录

基本信息

Path： /plugin/mch/api/mch/login

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
username	text	是		用户名
password	text	是		密码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ mch	object	非必须		商户信息
├─ id	number	非必须
├─ mall_id	number	非必须		商城ID
├─ user_id	number	非必须		用户ID
├─ status	number	非必须		是否营业0.否|1.是
├─ is_recommend	number	非必须		好店推荐：0.不推荐|1.推荐
├─ review_status	number	非必须		审核状态：0=待审核，1.审核通过.2=审核不通过
├─ review_remark	string	非必须		审核结果、备注
├─ review_time	string	非必须		审核时间
├─ realname	string	非必须		真实姓名
├─ wechat	string	非必须		微信号
├─ mobile	string	非必须		手机号码
├─ mch_common_cat_id	number	非必须		商户所属类目
├─ transfer_rate	number	非必须		商户手续费
├─ account_money	string	非必须		账户余额
├─ sort	number	非必须		店铺排序|升序
├─ form_data	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ token	string	非必须		商户登录token 商户接口需要在header中传入

多商户详情

基本信息

Path： /plugin/mch/api/mch/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	10	多商户ID
review_status	是	1	0.可查看未通过审核的商户信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须		商城ID
├─ user_id	number	非必须		用户ID
├─ status	number	非必须		是否营业0.否|1.是
├─ is_recommend	number	非必须		好店推荐：0.不推荐|1.推荐
├─ review_status	number	非必须		审核状态：0=待审核，1.审核通过.2=审核不通过
├─ review_remark	string	非必须		审核结果、备注
├─ review_time	string	非必须		审核时间
├─ realname	string	非必须		真实姓名
├─ wechat	string	非必须		微信号
├─ mobile	string	非必须		手机号码
├─ mch_common_cat_id	number	非必须		商户所属类目
├─ transfer_rate	number	非必须		商户手续费
├─ account_money	string	非必须		账户余额
├─ sort	number	非必须		店铺排序|升序
├─ form_data	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ user	object	非必须
├─ id	string	非必须		用户ID
├─ mall_id	string	非必须		商城ID
├─ mch_id	string	非必须		商户ID
├─ username	string	非必须		用户名
├─ password	string	非必须		密码
├─ nickname	string	非必须		用户昵称
├─ auth_key	string	非必须		授权key
├─ access_token	string	非必须		token
├─ mobile	string	非必须		手机号
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须		用户ID
├─ avatar	string	非必须		头像
├─ platform_user_id	string	非必须		用户所属平台的用户id
├─ integral	string	非必须		剩余积分
├─ total_integral	string	非必须		最高积分
├─ balance	string	非必须		余额
├─ total_balance	string	非必须		总余额
├─ parent_id	string	非必须		上级id
├─ is_blacklist	string	非必须		是否黑名单
├─ contact_way	string	非必须		联系方式
├─ remark	string	非必须		备注
├─ is_delete	string	非必须
├─ junior_at	string	非必须		成为下级时间
├─ platform	string	非必须		用户所属平台标识
├─ temp_parent_id	string	非必须		临时上级
├─ mchUser	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ store	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ address	string	非必须
├─ longitude	string	非必须
├─ latitude	string	非必须
├─ score	string	非必须
├─ cover_url	string	非必须
├─ pic_url	string	非必须
├─ business_hours	string	非必须
├─ description	string	非必须
├─ scope	string	非必须
├─ is_default	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ category	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ sort	string	非必须
├─ status	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须

多商户类目列表

基本信息

Path： /plugin/mch/api/mch/category

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1	分页

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须		类目ID
├─ mall_id	string	必须		商城ID
├─ name	string	必须		类目名称
├─ sort	string	必须		排序
├─ status	string	必须		是否显示
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

商品列表

基本信息

Path： /plugin/mch/api/goods/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1	分页
mch_id	是	10	多商户ID
sort	是	1	1.全部商品
sort_type	否	1	1.价格排序,升序
status	否		0.下架商品
keyword	否		搜索
is_sold_out	是		售罄商品 0.否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须		商品ID
├─ goods_warehouse_id	number	必须		商品库ID
├─ mch_id	number	必须		商户ID
├─ sign	string	必须		插件商品标识
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		商品缩略图
├─ original_price	string	必须		商品原价
├─ unit	string	必须		商品单位
├─ page_url	string	必须		商品轮播图
├─ is_negotiable	number	必须		是否面议0.否|1.是
├─ is_level	number	必须		是否显示会员价0.否|1.是
├─ level_price	number	必须		会员价
├─ price	string	必须		商品售价
├─ price_content	string	必须		商品显示价
├─ is_sales	string	必须		是否显示销量0.否|1.是
├─ sales	string	必须		销量（包含虚拟销量）
├─ vip_card_appoint	object	必须		超级会员卡
├─ discount	null	非必须		会员折扣
├─ is_my_vip_card_goods	number	非必须		登录用户是否享受商品折扣 1是 0否
├─ is_vip_card_user	number	非必须		登录用户是不是会员 1是 0否
├─ goods_stock	number	必须		商品库存
├─ status	number	必须		商品上下架状态0.下架|1.上架
├─ mch_goods	object	必须		多商户商品信息
├─ id	number	非必须		商户商品ID
├─ status	number	非必须		商户商品状态0.申请上架|1.申请中|2.同意上架|3.拒绝上架
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

商品详情

基本信息

Path： /plugin/mch/api/goods/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1	分页
mch_id	是	10	多商户ID
id	是	44	商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	string	非必须		商品ID
├─ mall_id	string	非必须		商城ID
├─ mch_id	string	非必须		商户ID
├─ goods_warehouse_id	string	非必须		关联商品库ID
├─ status	string	非必须		上架状态：0=下架，1=上架
├─ price	string	非必须		售价
├─ use_attr	string	非必须		是否使用规格：0=不使用，1=使用
├─ attr_groups	string	非必须		商品规格组
├─ goods_stock	string	非必须		商品总库存（规格库存相加）
├─ virtual_sales	string	非必须		已出售量（虚拟销量）
├─ confine_count	string	非必须		购物数量限制
├─ pieces	string	非必须		单品满件包邮
├─ forehead	string	非必须		单口满额包邮
├─ freight_id	string	非必须		运费模板ID
├─ give_integral	string	非必须		赠送积分
├─ give_integral_type	string	非必须		赠送积分类型1.固定值 |2.百分比
├─ forehead_integral	string	非必须		可抵扣积分
├─ forehead_integral_type	string	非必须		可抵扣积分类型1.固定值 |2.百分比
├─ accumulative	string	非必须		允许多件累计折扣
├─ individual_share	string	非必须		是否单独合伙人设置：0=否，1=是
├─ attr_setting_type	string	非必须		合伙人设置类型 0.普通设置|1.详细设置
├─ is_level	string	非必须		是否享受会员价购买
├─ is_level_alone	string	非必须		是否单独设置会员价
├─ share_type	string	非必须		合伙人佣金配比 0--固定金额 1--百分比
├─ sign	string	非必须		商品标示用于区分商品属于什么模块
├─ app_share_pic	string	非必须		商品自定义分享图片
├─ app_share_title	string	非必须		商品自定义分享标题
├─ is_default_services	string	非必须		默认服务 0.否|1.是
├─ sort	string	非必须		商品排序
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须		统计 支付人数
├─ payment_num	string	非必须		统计 支付件数
├─ payment_amount	string	非必须		统计 支付金额
├─ payment_order	string	非必须		支付订单数
├─ confine_order_count	string	非必须		限制下单数量
├─ is_area_limit	string	非必须		是否单独区域购买
├─ area_limit	string	非必须		区域限制详情 json格式
├─ share_level_type	string	非必须		合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_id	string	非必须		自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ name	string	非必须		商品名称
├─ original_price	string	非必须		商品原价
├─ cover_pic	string	非必须		商品缩略图
├─ unit	string	非必须		商品单位
├─ detail	string	非必须		商品详情
├─ video_url	string	非必须		商品视频链接
├─ level_show	number	非必须		会员价是否显示
├─ is_sales	number	非必须		销量是否显示
├─ attr	object []	非必须		规格	item 类型: object
├─ id	number	必须		规格ID
├─ goods_id	number	必须		商品ID
├─ sign_id	string	必须		规格组合，关联规格组
├─ stock	number	必须		库存
├─ price	string	必须		规格价
├─ no	string	必须		商品货号
├─ weight	number	必须		商品重量
├─ pic_url	string	必须		商品轮播图
├─ is_delete	number	必须
├─ attr_list	object []	必须			item 类型: object
├─ attr_group_name	string	必须		规格组名
├─ attr_group_id	number	必须		规格组ID
├─ attr_id	number	必须		规格ID
├─ attr_name	string	必须		规格名称
├─ price_member	number	必须
├─ member_price_list	string []	必须			item 类型: string
├─		非必须
├─ goods_num	number	非必须		商品数量
├─ goods_no	string	非必须		商品货号
├─ goods_weight	number	非必须		商品重量（单位：克）
├─ services	string []	非必须		商品服务	item 类型: string
├─		非必须
├─ cards	string []	非必须		商品赠送卡券	item 类型: string
├─		非必须
├─ price_min	number	非必须		商品最低价
├─ price_max	number	非必须		商品最高价
├─ pic_url	object []	非必须			item 类型: object
├─ pic_url	string	非必须
├─ id	number	非必须
├─ share	number	非必须
├─ sales	number	非必须
├─ favorite	boolean	非必须
├─ goods_marketing	object	非必须
├─ limit	string	非必须
├─ pickup	string	非必须
├─ shipping	string	非必须
├─ goods_marketing_award	object	非必须
├─ card	object	非必须
├─ title	string	非必须
├─ list	string []	非必须			item 类型: string
├─		非必须
├─ integral	object	非必须
├─ title	string	非必须
├─ vip_card_appoint	object	非必须		超级会员卡
├─ discount	null	非必须		会员折扣
├─ is_my_vip_card_goods	number	非必须		登录用户是否享受商品折扣 1是 0否
├─ is_vip_card_user	number	非必须		登录用户是不是会员 1是 0否

分类样式配置

基本信息

Path： /plugin/mch/api/goods/cat-style

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
mch_id	是	10	多商户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ setting	object	非必须
├─ cat_style	number	非必须		分类样式
├─ recommend_count	number	非必须		推荐商品显示数量
├─ cat_goods_count	number	非必须		分类商品显示数量
├─ cat_goods_cols	number	非必须		显示行数

商品分类列表

基本信息

Path： /api/default/cats-list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
mch_id	是	10	多商户ID
cat_id	否	0	0.全部

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ setting	object	非必须
├─ cat_style	number	非必须		分类样式
├─ recommend_count	number	非必须		推荐商品显示数量
├─ cat_goods_count	number	非必须		分类商品显示数量
├─ cat_goods_cols	number	非必须		显示行数

商城-多商户设置

基本信息

Path： /plugin/mch/api/mch/setting

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ setting	object	非必须
├─ cash_type	string []	非必须		提现类型：auto自动打款|wx微信线下转账|alipay|支付宝线下转账|bank银行卡|balance余额	item 类型: string
├─		非必须
├─ desc	string	非必须		入驻协议
├─ is_service	number	非必须		是否开启客服图标0.否|1.是
├─ form_data	object []	非必须		自定义表单	item 类型: object
├─ key	string	必须
├─ key_name	string	必须
├─ name	string	必须
├─ is_required	string	必须
├─ img_type	string	必须
├─ list	object []	必须			item 类型: object
├─ label	string	必须
├─ value	string	必须
├─ is_information	number	非必须		是否开启自定义审核资料0.否|1.j
├─ is_distance	number	非必须		是否开启商户距离排序0.否|1.是
├─ status	string	非必须

添加访客记录

基本信息

Path： /plugin/mch/api/mch/add-visit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
mch_id	text	是	10	商户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

商品上下架

基本信息

Path： /plugin/mch/api/goods/switch-status

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
page	否	1	分页
mch_id	是	10	多商户ID
id	是	44	商品ID

Body

参数名称	参数类型	是否必须	示例	备注
mch_id	text	是	10	多商户ID
id	text	是	1	商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

商品删除

基本信息

Path： /plugin/mch/api/goods/destroy

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
page	否	1	分页
mch_id	是	10	多商户ID
id	是	44	商品ID

Body

参数名称	参数类型	是否必须	示例	备注
mch_id	text	是	10	多商户ID
id	text	是	1	商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

商户订单详情

基本信息

Path： /plugin/mch/api/order/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1	分页
mch_id	是	10	多商户ID
id	是	44	订单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ mch_id	string	非必须
├─ order_no	string	非必须
├─ total_price	string	非必须
├─ total_pay_price	string	非必须
├─ express_original_price	string	非必须
├─ express_price	string	非必须
├─ total_goods_price	string	非必须
├─ total_goods_original_price	string	非必须
├─ member_discount_price	string	非必须
├─ use_user_coupon_id	string	非必须
├─ coupon_discount_price	string	非必须
├─ use_integral_num	string	非必须
├─ integral_deduction_price	string	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ address	string	非必须
├─ remark	string	非必须
├─ order_form	string	非必须
├─ words	string	非必须
├─ seller_remark	string	非必须
├─ is_pay	string	非必须
├─ pay_type	string	非必须
├─ pay_time	string	非必须
├─ is_send	string	非必须
├─ send_time	string	非必须
├─ express	string	非必须
├─ express_no	string	非必须
├─ is_sale	string	非必须
├─ is_confirm	string	非必须
├─ confirm_time	string	非必须
├─ cancel_status	string	非必须
├─ cancel_time	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_recycle	string	非必须
├─ is_offline	string	非必须
├─ offline_qrcode	string	非必须
├─ clerk_id	string	非必须
├─ store_id	string	非必须
├─ sign	string	非必须
├─ token	string	非必须
├─ detail	object []	非必须			item 类型: object
├─ id	string	非必须
├─ order_id	string	非必须
├─ goods_id	string	非必须
├─ num	string	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ member_discount_price	string	非必须
├─ goods_info	object	非必须
├─ name	string	非必须
├─ num	string	非必须
├─ total_original_price	string	非必须
├─ member_discount_price	string	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ pic_url	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ refund	null	非必须
├─ status_text	string	非必须
├─ pay_type_text	string	非必须
├─ goods_num	number	非必须

商户订单列表

基本信息

Path： /plugin/mch/api/order/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1	分页
mch_id	是	10	多商户ID
status	是	0	0.全部
order_type	否	order	order:普通订单（默认）
refund_status	否	all	all:全部（默认）
keyword	否	8219312938	订单号搜索
start_date	否	2019-06-01	开始时间
end_date	否	2019-07-01	结束时间

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ mch_id	string	必须
├─ order_no	string	必须
├─ total_price	string	必须
├─ total_pay_price	string	必须
├─ express_original_price	string	必须
├─ express_price	string	必须
├─ total_goods_price	string	必须
├─ total_goods_original_price	string	必须
├─ member_discount_price	string	必须
├─ use_user_coupon_id	string	必须
├─ coupon_discount_price	string	必须
├─ use_integral_num	string	必须
├─ integral_deduction_price	string	必须
├─ name	string	必须
├─ mobile	string	必须
├─ address	string	必须
├─ remark	string	必须
├─ order_form	string	必须
├─ words	string	必须
├─ seller_remark	string	必须
├─ is_pay	string	必须
├─ pay_type	string	必须
├─ pay_time	string	必须
├─ is_send	string	必须
├─ send_time	string	必须
├─ express	string	必须
├─ express_no	string	必须
├─ is_sale	string	必须
├─ is_confirm	string	必须
├─ confirm_time	string	必须
├─ cancel_status	string	必须
├─ cancel_time	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_recycle	string	必须
├─ is_offline	string	必须
├─ offline_qrcode	string	必须
├─ clerk_id	string	必须
├─ store_id	string	必须
├─ sign	string	必须
├─ token	string	必须
├─ detail	object []	必须			item 类型: object
├─ id	string	必须
├─ order_id	string	必须
├─ goods_id	string	必须
├─ num	string	必须
├─ unit_price	string	必须
├─ total_original_price	string	必须
├─ total_price	string	必须
├─ member_discount_price	string	必须
├─ goods_info	object	必须
├─ name	string	非必须
├─ num	string	非必须
├─ total_original_price	string	非必须
├─ member_discount_price	string	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	必须
├─ attr_group_id	number	必须
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ pic_url	string	非必须
├─ is_delete	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ comments	string []	必须			item 类型: string
├─		非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

店铺二维码

基本信息

Path： /plugin/mch/api/mch/qr-code

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
mch_id	是	10	商户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取二维码参数

基本信息

Path： /api/default/qr-code-parameter

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
token	否	parameter	二维码标识

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ user_id	number	非必须
├─ token	string	非必须
├─ data	object	非必须
├─ id	string	非必须
├─ created_at	string	非必须

店铺统计

基本信息

Path： /plugin/mch/api/mch/statistic

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
mch_id	是	10	多商户ID
monthly	是	1	月份

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ monthly_order_pay_price_count	number	非必须		当月成交额
├─ monthly_order_pay_price_average	number	非必须		当月每日平均成交额
├─ trend_arr	number []	非必须		价格走势	item 类型: number
├─		非必须
├─ contrast_prev_monthly	number	非必须		与上月相差金额

我的店铺首页

基本信息

Path： /plugin/mch/api/mch/manage-index

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
mch_id	是	10	多商户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ monthly_order_pay_price_count	number	非必须		当月成交额
├─ monthly_order_pay_price_average	number	非必须		当月每日平均成交额
├─ trend_arr	number []	非必须		价格走势	item 类型: number
├─		非必须
├─ contrast_prev_monthly	number	非必须		与上月相差金额

数据统计

数据统计-店铺查询

基本信息

Path： /mall/data-statistics/mch_list

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
name	text	否		模糊查询参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ mch_list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ name	string	非必须

合伙人排行

基本信息

Path： /mall/share-statistics/index

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
name	text	否		合伙人名
order	text	否	order=price desc	排序字段
flag	text	否	flag=EXPORT	导出字段
fields	text	否	fields=id,name	需要导出的字段
page	text	否		分页，需要get传值
platform	text	否		wxapp:微信

ttapp:头条
aliapp:支付宝
bdapp:百度 |

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须		ID
├─ name	string	必须		合伙人
├─ total_money	string	必须		累计佣金
├─ first_children	string	必须		直接下级数量
├─ all_children	string	必须		总下级数量
├─ all_money	string	必须		总佣金
├─ all_order	string	必须		合伙人订单数
├─ price	string	必须		已提现佣金
├─ export_list	object []	非必须		导出字段列表	item 类型: object
├─ key	string	必须
├─ value	string	必须

商品分类列表

基本信息

Path： /mall/order-statistics/cats_list

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
cats_ids	text	否	cats_ids=1或=1,2	分类id，多id使用英文逗号隔开
cats_name	text	否		分类名称模糊查询

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ name	string	非必须		分类名称

头部公告

基本信息

Path： /mall/data-statistics/notice

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ first	string []	非必须			item 类型: string
├─		非必须
├─ list	string []	非必须			item 类型: string
├─		非必须
├─ mall_notice	string	非必须
├─ pagination	null	非必须

头部总览数据

基本信息

Path： /mall/data-statistics/all-data

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ user_count	string	非必须		用户数
├─ goods_num	string	非必须		商品数
├─ order_num	string	非必须		订单数
├─ pay_num	string	非必须		支付件数
├─ pay_price	string	非必须		支付金额
├─ wait_send_num	string	非必须		代发货数
├─ wait_pay_num	string	非必须		待支付数
├─ pro_order	string	非必须		售后数

对账单

基本信息

Path： /mall/price-statistics/index

Method： POST

接口描述：
undefined

请求参数

幸运抽奖

基本信息

Path： /mall/lottery-statistics/index

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
date_start	text	否
date_end	text	否
name	text	否
flag	text	否
page	text	否
order	text	否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须			item 类型: object
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		图片
├─ attr_groups	string	必须		规格
├─ participant	string	必须		参与人数
├─ invitee	string	必须		被邀请人数
├─ code_num	string	必须		奖卷
├─ status	string	必须		状态

拼团

基本信息

Path： /mall/pintuan-statistics/index

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
date_start	text	否
date_end	text	否
name	text	否
order	text	否
flag	text	否
page	text	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须			item 类型: object
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		图片
├─ all_user	string	必须		拼团人数
├─ success_user	string	必须		成团人数
├─ pay_user	string	必须		支付人数
├─ goods_num	string	必须		支付件数
├─ total_pay_price	string	必须		支付金额
├─ status	string	必须		状态
├─ success_100	string	必须		成团率

插件菜单

基本信息

Path： /mall/data-statistics/plugin-menus

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
menus	object []	非必须			item 类型: object
├─ name	string	必须
├─ key	string	必须
├─ pic_url	string	必须
├─ route	string	必须

数据统计

基本信息

Path： /mall/data-statistics/index

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
date_start	text	否		开始时间
date_end	text	否		结束时间
mch_id	text	否		店铺ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ goods_top_list	object []	非必须		商品购买力TOP表	item 类型: object
├─ name	string	必须		商品
├─ total_price	string	必须		销售额
├─ num	string	必须		销售量
├─ user_top_list	object []	非必须		用户购买力TOP表	item 类型: object
├─ nickname	string	必须		用户
├─ avatar	string	必须		头像
├─ total_price	string	必须		支付金额
├─ num	string	必须		购买件数

数据统计-商品排序导出

基本信息

Path： /mall/data-statistics/goods_top

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
mch_id	text	否		店铺ID
date_start	text	否		开始时间
date_end	text	否		结束时间
goods_order	text	否	order=total_price DESC	排序
flag	text	否	flag=EXPORT	导出标签

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ all_data	null	非必须
├─ mch_list	null	非必须
├─ goods_top_list	object []	非必须			item 类型: object
├─ name	string	必须		商品
├─ total_price	string	必须		销售额
├─ num	string	必须		销售量
├─ user_top_list	null	非必须
├─ table_list	null	非必须

数据统计-图表

基本信息

Path： /mall/data-statistics/table

Method： POST

接口描述：

默认返回昨日数据

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
mch_id	text	否
date_start	text	否
date_end	text	否
type	text	否		1支付数据，2收益数据

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ created_at	string	必须		x轴时间
├─ user_num	string	必须		支付人数
├─ order_num	string	必须		支付订单数
├─ total_pay_price	string	必须		支付金额
├─ goods_num	string	必须		支付件数
├─ table_data	object	必须		图表总数据
├─ user_num	string	必须		支付人数
├─ order_num	string	必须		支付订单数
├─ total_pay_price	string	必须		支付金额
├─ goods_num	string	必须		支付件数

发放统计

基本信息

Path： /mall/send-statistics/index

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
name	text	否		名称
date_start	text	否		开始时间
date_end	text	否		结束时间
type	text	否		coupon 优惠卷，card 卡卷
flag	text	否	EXPORT	EXPORT
page	text	否		分页，需要get传值
platform	text	否		wxapp:微信

ttapp:头条
aliapp:支付宝
bdapp:百度 |

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ all_data	object	必须		总发放
├─ all_num	string	必须
├─ unuse_num	string	必须
├─ use_num	string	必须
├─ end_num	string	必须
├─ list	object []	非必须			item 类型: object
├─ date	string	必须		日期
├─ name	string	必须		名称
├─ all_num	string	必须		发放总数
├─ unuse_num	string	必须		未使用数
├─ use_num	string	必须		已使用数
├─ end_num	string	必须		失效数

数据统计-用户排序导出

基本信息

Path： /mall/data-statistics/users_top

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
mch_id	text	是		店铺ID
date_start	text	是		开始时间
date_end	text	是		结束时间
user_order	text	是	order=total_price DESC	排序
flag	text	是	flag=EXPORT	导出标签
platform	text	否		wxapp:微信

ttapp:头条
aliapp:支付宝
bdapp:百度 |

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ all_data	null	非必须
├─ mch_list	null	非必须
├─ goods_top_list	null	非必须
├─ user_top_list	object []	非必须			item 类型: object
├─ nickname	string	必须		用户
├─ total_price	string	必须		支付金额
├─ num	string	必须		购买件数
├─ table_list	null	非必须

整点秒杀

基本信息

Path： /mall/miaosha-statistics/index

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
date_start	text	否		开始时间
date_end	text	否		结束时间
name	text	否		商品名称
order	text	否		排序字段
flag	text	否	EXPORT	导出
page	text	否		分页，需要get传值

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须			item 类型: object
├─ miaosha_time	string	必须		秒杀时间
├─ cover_pic	string	必须		图片
├─ name	string	必须		商品名称
├─ user_num	string	必须		支付人数
├─ goods_num	string	必须		支付件数
├─ pay_price	string	必须		支付金额
├─ status	string	必须		状态

步数兑换

基本信息

Path： /mall/step-statistics/ex

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
data_start	text	否
data_end	text	否
flag	text	否
page	text	否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ all_data	object	非必须
├─ c_date	string	非必须
├─ step_num	string	非必须		总兑换步数
├─ user_num	string	非必须		兑换人数
├─ goods_num	string	非必须		兑换商品数
├─ goods_pay	string	非必须		兑换金额/活力币
├─ list	object []	非必须			item 类型: object
├─ c_date	string	必须
├─ step_num	string	必须
├─ user_num	string	必须
├─ goods_num	string	必须
├─ goods_pay	string	必须

步数挑战

基本信息

Path： /mall/step-statistics/index

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
data_start	text	否
data_end	text	否
name	text	否
flag	text	否
page	text	否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须			item 类型: object
├─ begin_at	string	非必须		活动时间
├─ title	string	非必须		活动名称
├─ step_num	string	非必须		挑战步数
├─ currency	string	非必须		奖金池
├─ participate_num	string	非必须		参与人数
├─ success_num	string	非必须		成功人数
├─ put_currency	string	非必须		报名活力币

砍价

基本信息

Path： /mall/bargain-statistics/index

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
date_start	text	否
date_end	text	否
name	text	否
order	text	否
flag	text	否
page	text	否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须			item 类型: object
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		图片
├─ attr_groups	string	必须		规格
├─ min_price	string	必须		活动价
├─ initiator	string	必须		发起人数
├─ participant	string	必须		参与人数
├─ min_price_goods	string	必须		砍到最低商品数
├─ underway	string	必须		进行中活动数
├─ success	string	必须		成功活动数
├─ fail	string	必须		失败活动数
├─ payment_people	string	必须		支付人数
├─ payment_num	string	必须		支付件数
├─ payment_amount	string	必须		支付金额
├─ status	string	必须		状态

积分商城

基本信息

Path： /mall/integral-statistics/mall

Method： POST

接口描述：

未安装相关插件，接口会500报错

{
"code": 500,
"msg": "插件integral_mall1相关类Plugin不存在。",
"data": null,
"error": [
"#162: E:/foal_store/core/Plugin.php",
"#0: app\\controllers\\mall\\IntegralStatisticsController->actionMall()",
"#57: E:/foal_store/vendor/yiisoft/yii2/base/InlineAction.php",
"#157: E:/foal_store/vendor/yiisoft/yii2/base/Controller.php",
"#528: E:/foal_store/vendor/yiisoft/yii2/base/Module.php",
"#233: E:/foal_store/core/Application.php",
"#103: E:/foal_store/vendor/yiisoft/yii2/web/Application.php",
"#386: E:/foal_store/vendor/yiisoft/yii2/base/Application.php",
"#16: E:/foal_store/web/index.php"
]
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
date_start	text	否		开始时间
date_end	text	否		结束时间
flag	text	否	EXPORT	EXPORT
page	text	否		分页，需要get传值
platform	text	否		wxapp:微信

ttapp:头条
aliapp:支付宝
bdapp:百度 |

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ all_data	object []	非必须		总兑换	item 类型: object
├─ coupons_num	string	非必须
├─ user_num	string	非必须
├─ goods_num	string	非必须
├─ goods_integral	string	非必须
├─ goods_price	string	非必须
├─ list	object []	非必须			item 类型: object
├─ date	string	必须		日期
├─ coupons_num	string	必须		兑换优惠卷数
├─ user_num	string	必须		兑换商品人数
├─ goods_num	string	必须		兑换商品数
├─ goods_integral	string	必须		兑换支出积分
├─ goods_price	string	必须		兑换支出金额

积分收支

基本信息

Path： /mall/integral-statistics/index

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
date_start	text	否
date_end	text	否
flag	text	否	EXPORT	EXPORT
page	text	否		分页，需要get传值
platform	text	否		wxapp:微信

ttapp:头条
aliapp:支付宝
bdapp:百度 |

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ all_data	object []	非必须		总收支	item 类型: object
├─ in_integral	string	非必须		总收入
├─ out_integral	string	非必须		总支出
├─ list	object []	非必须			item 类型: object
├─ date	string	必须		日期
├─ in_integral	string	必须		积分收入
├─ out_integral	string	必须		积分支出

经营概况

基本信息

Path： /mall/data-statistics/all-num

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
is_store	text	否		1门店页面
mch_id	text	否		门店ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ order_data	object	非必须
├─ user_num	string	非必须
├─ order_num	string	非必须
├─ total_pay_price	string	非必须
├─ goods_num	string	非必须
├─ user_num_status	string	非必须
├─ order_num_status	string	非必须
├─ total_pay_price_status	string	非必须
├─ goods_num_status	string	非必须
├─ user_data	object	非必须
├─ user_num	string	非必须
├─ data_num	string	非必须
├─ user_num_status	string	非必须
├─ data_num_status	string	非必须
├─ pay_data	object	非必须
├─ 1	object	非必须
├─ amount_status	string	非必须
├─ amount	string	非必须
├─ refund	string	非必须
├─ 2	object	非必须
├─ amount_status	string	非必须
├─ amount	string	非必须
├─ refund	string	非必须
├─ 3	object	非必须
├─ amount_status	string	非必须
├─ amount	string	非必须
├─ refund	string	非必须
├─ 4	object	非必须
├─ amount_status	string	非必须
├─ amount	string	非必须
├─ refund	string	非必须

裂变拆红包

基本信息

Path： /mall/fxhb-statistics/index

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
date_start	text	否		开始时间
date_end	text	否		结束时间
name	text	否		活动名称
flag	text	否	EXPORT	EXPORT
page	text	否		分页，需要get传值
platform	text	否		wxapp:微信

ttapp:头条
aliapp:支付宝
bdapp:百度 |

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须			item 类型: object
├─ start_time	string	必须		活动开始时间
├─ end_time	string	必须		活动结束时间
├─ name	string	必须		活动名称
├─ number	string	必须		所需人数
├─ launch_user_num	string	必须		发起人数
├─ participate_num	string	必须		参与人数
├─ launch_num	string	必须		发起数量
├─ success_num	string	必须		成功数量
├─ coupon_num	string	必须		发放优惠卷数量
├─ coupon_price	string	必须		发放优惠卷总金额
├─ status	string	必须		状态

销售统计-门店-多商户

基本信息

Path： /mall/order-statistics/index

Method： POST

接口描述：

"sign": "booking"               预约订单

"sign": "integral_mall"       积分商城

"sign": "miaosha"              秒杀订单

"sign": "pintuan"                拼团订单

"sign": "bargain"                砍价订单

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
date_start	text	否		开始时间
date_end	text	否		结束时间
status	text	否		状态 -1全部，0未完成，1已完成，3已取消，4售后中，5售后完成
flag	text	否		导出字段 EXPORT
fields	text	否	fields=id,name	需要导出的字段
page	text	否		分页，需要get传值
mch_id	text	否		多商户
store_id	text	否		门店
platform	text	否		wxapp:微信

ttapp:头条
aliapp:支付宝
bdapp:百度 |

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ plugins_list	object []	必须		插件列表	item 类型: object
├─ sign	string	必须		看备注字段说明
├─ name	string	必须		名称
├─ all	object	非必须		总成交
├─ user_num	string	非必须
├─ order_num	string	非必须
├─ total_pay_price	string	非必须
├─ goods_num	string	非必须
├─ now	object	非必须		今日成交
├─ user_num	string	非必须
├─ order_num	string	非必须
├─ total_pay_price	string	非必须
├─ goods_num	string	非必须
├─ list	object []	非必须			item 类型: object
├─ created_at	string	必须		日期
├─ user_num	string	必须		付款人数
├─ order_num	string	必须		付款订单数
├─ total_pay_price	string	必须		付款金额
├─ goods_num	string	必须		付款件数
├─ export_list	object []	非必须		导出字段列表	item 类型: object
├─ key	string	必须
├─ value	string	必须

预约

基本信息

Path： /mall/booking-statistics/index

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
date_start	text	否
date_end	text	否
name	text	否
order	text	否
flag	text	否
page	text	否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须			item 类型: object
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		图片
├─ pay_user	string	必须		支付人数
├─ goods_num	string	必须		支付件数
├─ total_pay_price	string	必须		支付金额

小程序管理界面

商品编辑获取配置

基本信息

Path： /admin/goods/goods-config

Method： GET

接口描述：

电子卡密插件新增：is_ecard、ecard_api_url；

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	必须
msg	string	必须
data	object	必须
├─ is_ecard	integer	必须		是否可使用电子卡密
├─ ecard_api_url	string	必须		小程序端请求路径

会员列表

基本信息

Path： /api/admin/user/all-member

Method： GET

接口描述：

订单消息跳转到订单列表的时候，带订单号过去直接查询，并根据状态如下进行状态显示
is_pay = 0  未付款
is_pay = 1 或者 pay_type = 2  已付款

售后消息跳转到售后列表

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ mch_id	string	必须
├─ order_no	string	必须
├─ total_price	string	必须
├─ total_pay_price	string	必须
├─ express_price	string	必须
├─ total_goods_price	string	必须
├─ total_goods_original_price	string	必须
├─ member_discount_price	string	必须
├─ use_user_coupon_id	string	必须
├─ coupon_discount_price	string	必须
├─ use_integral_num	string	必须
├─ integral_deduction_price	string	必须
├─ name	string	必须
├─ mobile	string	必须
├─ address	string	必须
├─ remark	string	必须
├─ order_form	object,null	必须
├─ words	string	必须
├─ seller_remark	string	必须
├─ is_pay	string	必须
├─ pay_type	string	必须
├─ pay_time	string	必须
├─ is_send	string	必须
├─ send_time	string	必须
├─ express	string	必须
├─ express_no	string	必须
├─ is_sale	string	必须
├─ is_confirm	string	必须
├─ confirm_time	string	必须
├─ cancel_status	string	必须
├─ cancel_time	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_recycle	string	必须
├─ is_offline	string	必须
├─ offline_qrcode	string	必须
├─ clerk_id	string	必须
├─ store_id	string	必须
├─ token	string	必须
├─ nickname	string	必须		用户昵称
├─ detail	object []	必须		订单详情信息（备注见order_detail）	item 类型: object
├─ id	string	必须
├─ order_id	string	必须
├─ goods_id	string	必须
├─ num	string	必须
├─ unit_price	string	必须
├─ total_original_price	string	必须
├─ total_price	string	必须
├─ member_discount_price	string	必须
├─ goods_info	string	必须
├─ is_delete	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ goods	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ price	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ status	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ virtual_sales	string	非必须
├─ sort	string	非必须
├─ is_quick_shop	string	非必须
├─ is_sell_well	string	非必须
├─ is_level	string	非必须
├─ confine_count	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ is_negotiable	string	非必须
├─ freight_id	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ refund	null	必须		商品售后情况
├─ attr_list	object []	必须		商品规格	item 类型: object
├─ attr_group_name	string	必须		规格组
├─ attr_group_id	number,string	必须
├─ attr_id	number,string	必须
├─ attr_name	string	必须		规格名
├─ clerk	object	必须		核销人信息
├─ field_2	string	必须
├─ store	object	必须		门店信息
├─ exportList	string []	非必须		导出信息（未处理）	item 类型: string
├─		非必须

门店列表

基本信息

Path： /api/admin/user/store

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

退货退款订单确认收货

基本信息

Path： /api/admin/order/shou-huo

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Body

参数名称	参数类型	是否必须	示例	备注
refund_order_id	text	是	1	售后订单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

评价置顶

基本信息

Path： /admin/order-comments/update-top

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
status	text	是	1	是否置顶0.否
id	text	是	1	评价ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

订单添加备注

基本信息

Path： /api/admin/order/seller-remark

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Body

参数名称	参数类型	是否必须	示例	备注
order_id	text	是	1	订单ID
seller_remark	text	是	备注信息	备注信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ value	string	必须
├─ label	string	必须
├─ children	object []	必须			item 类型: object
├─ value	string	必须
├─ label	string	必须
├─ children	object []	必须			item 类型: object
├─ value	string	必须
├─ label	string	必须

订单发货

基本信息

Path： /api/admin/order/send

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
order_id	text	是	152	订单ID
mch_id	text	是	10	多商户ID
express	text	是	顺丰速运
customer_name	text	是		快递为京东物流时需填写
express_no	text	是	218371209380918
words	text	否	备注
is_express	text	是		是否快递发货0.否
order_detail_id	text	是	[1,2]	商品详情ID 类型:Array
express_content	text	是	物流备注	无需物流备注
express_id	text	是	1	分批物流编辑时，传物流ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ code	string	必须

后台绑定管理员

基本信息

Path： /admin/user/bind

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
user_id	text	是		用户ID
we7_user_id	text	否		微擎User ID 独立版不传

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

后台解绑管理员

基本信息

Path： /admin/user/destroy-bind

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是		用户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

解除核销员

基本信息

Path： /api/admin/user/clerkdestroy

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	61	用户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
field_1	string	必须

获取面单

基本信息

Path： /api/admin/order/print

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
order_id	是	1	订单ID
express	是	顺丰速运	快递公司
mch_id	是	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息

获取提现消息tab栏

基本信息

Path： /api/admin/cash/tabs

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token		是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object []	非必须			item 类型: object
├─ typeid	number	必须
├─ type	string	必须

队长审核队列查询

基本信息

Path： /api/admin/review/queue-status

Method： GET

接口描述：
undefined

请求参数

商品详情

基本信息

Path： /api/admin/goods/edit

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
id	是	1	商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ mall_id	number	非必须		商城ID
├─ name	string	非必须		商品名称
├─ original_price	string	非必须		商品原价
├─ cost_price	string	非必须		商品成本价
├─ detail	string	非必须		商品详情
├─ cover_pic	string	非必须		商品缩略图
├─ pic_url	object []	非必须		商品轮播图	item 类型: object
├─ id	string	非必须
├─ pic_url	string	非必须		url
├─ video_url	string	非必须		商品视频
├─ unit	string	非必须		单位
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ mch_id	number	非必须		商户ID
├─ goods_warehouse_id	number	非必须		商品库ID
├─ status	string	非必须		上架状态：0=下架，1=上架
├─ price	string	非必须		售价
├─ use_attr	string	非必须		是否使用规格：0=不使用，1=使用
├─ attr_groups	string	非必须		商品规格组
├─ goods_stock	string	非必须		商品总库存（规格库存相加）
├─ virtual_sales	string	非必须		已出售量（虚拟销量）
├─ confine_count	string	非必须		购物数量限制
├─ pieces	string	非必须		单品满件包邮
├─ forehead	string	非必须		单口满额包邮
├─ freight_id	string	非必须		运费模板ID
├─ give_integral	string	非必须		赠送积分
├─ give_integral_type	string	非必须		赠送积分类型1.固定值 |2.百分比
├─ forehead_integral	string	非必须		可抵扣积分
├─ forehead_integral_type	string	非必须		可抵扣积分类型1.固定值 |2.百分比
├─ accumulative	string	非必须		允许多件累计折扣
├─ individual_share	string	非必须		是否单独合伙人设置：0=否，1=是
├─ attr_setting_type	string	非必须		合伙人设置类型 0.普通设置|1.详细设置
├─ is_level	string	非必须		是否享受会员价购买
├─ is_level_alone	string	非必须		是否单独设置会员价
├─ share_type	string	非必须		合伙人佣金配比 0--固定金额 1--百分比
├─ sign	string	非必须		商品标示用于区分商品属于什么模块
├─ app_share_pic	string	非必须		商品自定义分享图片
├─ app_share_title	string	非必须		商品自定义分享标题
├─ is_default_services	string	非必须		默认服务 0.否|1.是
├─ sort	string	非必须		商品排序
├─ payment_people	string	非必须		统计 支付人数
├─ payment_num	string	非必须		统计 支付件数
├─ payment_amount	string	非必须		统计 支付金额
├─ payment_order	string	非必须		支付订单数
├─ confine_order_count	string	非必须		限制下单数量
├─ is_area_limit	string	非必须		是否单独区域购买
├─ area_limit	string	非必须		区域限制详情 json格式
├─ share_level_type	string	非必须		合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_id	string	非必须		自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ attr	object []	非必须			item 类型: object
├─ id	number	非必须		规格ID
├─ goods_id	number	非必须		商品ID
├─ sign_id	string	非必须		规格组合，关联规格组
├─ stock	number	非必须		库存
├─ price	string	非必须		规格价
├─ no	string	非必须		商品货号
├─ weight	number	非必须		商品重量
├─ pic_url	string	非必须		商品轮播图
├─ is_delete	number	非必须
├─ attr_list	object []	非必须		规格组信息	item 类型: object
├─ attr_group_name	string	必须		规格组名
├─ attr_group_id	number	必须		规格组ID
├─ attr_id	number	必须		规格ID
├─ attr_name	string	必须		规格名称
├─ price_member	number	非必须		会员价
├─ member_price_list	object []	非必须			item 类型: object
├─ id	number	必须
├─ level	number	必须
├─ price	string	必须
├─ goods_attr_id	number	必须
├─ is_delete	number	必须
├─ goods_id	number	必须
├─ member_price	object	非必须
├─ level2	number	非必须
├─ level3	number	非必须
├─ share_commission_first	number	非必须
├─ share_commission_second	number	非必须
├─ share_commission_third	number	非必须
├─ share_commission_first	string	非必须		一级合伙人金额
├─ share_commission_second	string	非必须		二级合伙人金额
├─ share_commission_third	string	非必须		三级合伙人金额
├─ member_price	object	非必须		自定义会员价
├─ level2	number	非必须
├─ level3	number	非必须
├─ goods_no	string	非必须		商品货号
├─ goods_weight	number	非必须		商品重量
├─ goods_num	number	非必须		商品数量
├─ goods_warehouse	object	非必须		商品库商品信息
├─ goods_id	number	非必须		商品ID
├─ name	string	非必须		商品名称
├─ original_price	string	非必须		商品原价
├─ attr_groups	object []	非必须		商品规格组	item 类型: object
├─ attr_group_id	number	非必须
├─ attr_group_name	string	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ cats	object []	非必须		商品分类	item 类型: object
├─ label	string	非必须
├─ value	number	非必须
├─ mchCats	string []	非必须		商户分类信息	item 类型: string
├─		非必须
├─ services	string []	非必须		商品服务信息	item 类型: string
├─		非必须
├─ cards	string []	非必须		商品卡券信息	item 类型: string
├─		非必须
├─ freight	object	非必须		运费规则
├─ id	number	非必须		规则ID
├─ name	string	非必须		规则名称
├─ attr_default_name	string	非必须
├─ is_vip_card_goods	number	非必须
├─ is_quick_shop	number	非必须		是否加入快速购买0.否|1.是
├─ is_sell_well	number	非必须		是否热销0.否|1.是
├─ is_negotiable	number	非必须		是否面议0.否|1.是

确认收货

基本信息

Path： /api/admin/order/confirm

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
order_id	是

Body

参数名称	参数类型	是否必须	示例	备注
order_id	text	是		订单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

审核消息列表--第二版

基本信息

Path： /api/admin/v2/review/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
key	是	share	请求数据标示
keyword	否		名称搜索
page	否	1	页码

返回数据

名称	类型	是否必须	默认值	备注	其他信息

审核消息处理--第二版

基本信息

Path： /api/admin/v2/review/switch-status

Method： GET

接口描述：
undefined

请求参数

审核消息详情--第二版

基本信息

Path： /api/admin/v2/review/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
key	是	mch	插件标示
id	否		多商户id
user_id	否		待审核人员的用户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息

提现审核

基本信息

Path： /api/admin/cash/verify

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Body

参数名称	参数类型	是否必须	示例	备注
type	text	是	1	1为入驻商 2为合伙人

返回数据

名称	类型	是否必须	默认值	备注	其他信息

提现审核与打款(新)

基本信息

Path： /api/admin/cash/save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
status	text	是	1	1：同意

2：打款
3：拒绝 |
| model_type | text | 是 | | mch:多商户
share:合伙人
bonus:团队分红
stock：股东分红
region：区域代理 |
| content | text | 否 | 备注内容 | |

返回数据

名称	类型	是否必须	默认值	备注	其他信息

提现审核列表

基本信息

Path： /api/admin/cash/index

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
type	是	1	1为入驻商 2为合伙人
status	是	0	0为未审核 1为打款中

返回数据

名称	类型	是否必须	默认值	备注	其他信息

提现审核列表(新)

基本信息

Path： /api/admin/cash/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1
status	是	3
keyword	否
model_type	是	mch	mch:多商户 share:合伙人 bonus:团队分红 stock：股东分红 region：区域代理

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ order_no	string	必须
├─ pay_type	string	必须
├─ type	string	必须
├─ status	number	必须
├─ user	object	必须
├─ name	string	非必须
├─ phone	string	非必须
├─ avatar	string	非必须
├─ nickname	string	非必须
├─ platform	string	非必须
├─ cash	object	必须
├─ price	number	非必须
├─ service_charge	number	非必须
├─ actual_price	number	非必须
├─ extra	object	必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ bank_name	string	非必须
├─ time	object	必须
├─ created_at	string	非必须
├─ apply_at	string	非必须
├─ remittance_at	string	非必须
├─ reject_at	string	非必须
├─ content	object	必须
├─ apply_content	string	非必须
├─ remittance_content	string	非必须
├─ reject_content	string	非必须
├─ model	string	必须
├─ model_text	string	必须
├─ remark	null,string	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ export_list	object []	非必须			item 类型: object
├─ key	string	必须
├─ value	string	必须

更新用户备注名

基本信息

Path： /api/admin/user/update-user-remark-name

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
id	是	1	用户ID
remark	是		备注信息

Body

参数名称	参数类型	是否必须	示例	备注
remark_name	text	是	备注名	备注名
id	text	是	1	用户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

更新用户备注

基本信息

Path： /api/admin/user/update-user-remark

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
id	是	1	用户ID
remark	是		备注信息

Body

参数名称	参数类型	是否必须	示例	备注
remark	text	是	联系157..	备注
id	text	是	1	用户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

更新用户会员等级

基本信息

Path： /api/admin/user/update-user-level

Method： POST

接口描述：

订单消息跳转到订单列表的时候，带订单号过去直接查询，并根据状态如下进行状态显示
is_pay = 0  未付款
is_pay = 1 或者 pay_type = 2  已付款

售后消息跳转到售后列表

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
id	是	1	用户ID
member_level	是	1	会员等级

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ mch_id	string	必须
├─ order_no	string	必须
├─ total_price	string	必须
├─ total_pay_price	string	必须
├─ express_price	string	必须
├─ total_goods_price	string	必须
├─ total_goods_original_price	string	必须
├─ member_discount_price	string	必须
├─ use_user_coupon_id	string	必须
├─ coupon_discount_price	string	必须
├─ use_integral_num	string	必须
├─ integral_deduction_price	string	必须
├─ name	string	必须
├─ mobile	string	必须
├─ address	string	必须
├─ remark	string	必须
├─ order_form	object,null	必须
├─ words	string	必须
├─ seller_remark	string	必须
├─ is_pay	string	必须
├─ pay_type	string	必须
├─ pay_time	string	必须
├─ is_send	string	必须
├─ send_time	string	必须
├─ express	string	必须
├─ express_no	string	必须
├─ is_sale	string	必须
├─ is_confirm	string	必须
├─ confirm_time	string	必须
├─ cancel_status	string	必须
├─ cancel_time	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_recycle	string	必须
├─ is_offline	string	必须
├─ offline_qrcode	string	必须
├─ clerk_id	string	必须
├─ store_id	string	必须
├─ token	string	必须
├─ nickname	string	必须		用户昵称
├─ detail	object []	必须		订单详情信息（备注见order_detail）	item 类型: object
├─ id	string	必须
├─ order_id	string	必须
├─ goods_id	string	必须
├─ num	string	必须
├─ unit_price	string	必须
├─ total_original_price	string	必须
├─ total_price	string	必须
├─ member_discount_price	string	必须
├─ goods_info	string	必须
├─ is_delete	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ goods	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ price	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ status	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ virtual_sales	string	非必须
├─ sort	string	非必须
├─ is_quick_shop	string	非必须
├─ is_sell_well	string	非必须
├─ is_level	string	非必须
├─ confine_count	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ is_negotiable	string	非必须
├─ freight_id	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ refund	null	必须		商品售后情况
├─ attr_list	object []	必须		商品规格	item 类型: object
├─ attr_group_name	string	必须		规格组
├─ attr_group_id	number,string	必须
├─ attr_id	number,string	必须
├─ attr_name	string	必须		规格名
├─ clerk	object	必须		核销人信息
├─ field_2	string	必须
├─ store	object	必须		门店信息
├─ exportList	string []	非必须		导出信息（未处理）	item 类型: string
├─		非必须

首页总览数据

基本信息

Path： /api/admin/data-statistics/all_data

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
date_start	text	是
date_end	text	是
sign	text	是		插件分类查询

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ plugins_list	object []	非必须			item 类型: object
├─ sign	string	必须		插件参数
├─ name	string	必须		插件名称
├─ all_data	object	非必须
├─ user_count	string	非必须		总用户数
├─ goods_num	string	非必须		商品数
├─ order_num	string	非必须		总订单数
├─ pay_num	string	非必须		支付订单数
├─ wait_send_num	string	非必须		代发货数
├─ pro_order	string	非必须		维权订单数
├─ pay_price	string	非必须		支付金额
├─ wait_pay_num	string	非必须		代付款订单数
├─ new_msg_num	object	非必须
├─ order_num	number	必须		新订单数
├─ cash_num	number	必须
├─ review_num	number	必须

物流列表

基本信息

Path： /api/order/express-list

Method： GET

接口描述：
undefined

请求参数

获取商品列表

基本信息

Path： /api/admin/goods/index

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
page	否	1
search	否	{"keyword":"","status":""}	keyword：模糊搜索 status 0为下架中 1为上架中

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须
├─ mall_id	number	必须
├─ mch_id	number	必须
├─ goods_warehouse_id	number	必须
├─ status	number	必须
├─ price	string	必须
├─ use_attr	number	必须
├─ attr_groups	string	必须
├─ goods_stock	number	必须
├─ virtual_sales	number	必须
├─ confine_count	number	必须
├─ pieces	number	必须
├─ forehead	string	必须
├─ freight_id	number	必须
├─ give_integral	number	必须
├─ give_integral_type	number	必须
├─ forehead_integral	number	必须
├─ forehead_integral_type	number	必须
├─ accumulative	number	必须
├─ individual_share	number	必须
├─ attr_setting_type	number	必须
├─ is_level	number	必须
├─ is_level_alone	number	必须
├─ share_type	number	必须
├─ sign	string	必须
├─ app_share_pic	string	必须
├─ app_share_title	string	必须
├─ is_default_services	number	必须
├─ sort	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	number	必须
├─ payment_people	number	必须
├─ payment_num	number	必须
├─ payment_amount	string	必须
├─ payment_order	number	必须
├─ goodsWarehouse	object	必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ mchGoods	null []	必须			item 类型: null
├─		非必须
├─ cats	object []	必须			item 类型: object
├─ id	number	必须
├─ mall_id	number	必须
├─ mch_id	number	必须
├─ parent_id	number	必须
├─ name	string	必须
├─ pic_url	string	必须
├─ sort	number	必须
├─ big_pic_url	string	必须
├─ advert_pic	string	必须
├─ advert_url	string	必须
├─ status	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	number	必须
├─ mchCats	string []	必须			item 类型: string
├─		非必须
├─ mallGoods	object	必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ goods_id	number	非必须
├─ is_quick_shop	number	非必须
├─ is_sell_well	number	非必须
├─ is_negotiable	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ name	string	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

商品上下架

基本信息

Path： /api/admin/goods/switch-status

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Body

参数名称	参数类型	是否必须	示例	备注
status	text	是	1	1上架 0下架
id	text	是	1028	商品id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

删除商品

基本信息

Path： /api/admin/goods/destroy

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	1028	商品id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

评价列表

基本信息

Path： /api/admin/order-comments/index

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
is_reply	否	1	0未回复（默认） 1已回复
score	否	1	1差评 2中评 3好评（默认）
page	否	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ order_id	string	非必须
├─ order_detail_id	string	非必须
├─ user_id	string	非必须
├─ score	string	非必须
├─ content	string	非必须
├─ pic_url	string []	非必须			item 类型: string
├─		非必须
├─ is_show	string	非必须
├─ is_virtual	string	非必须
├─ virtual_user	string	非必须
├─ virtual_avatar	string	非必须
├─ virtual_time	string	非必须
├─ goods_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ sign	string	非必须
├─ reply_content	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_anonymous	string	非必须
├─ nickname	string	非必须
├─ name	string	非必须
├─ cover_pic	string	非必须
├─ platform	string	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

回复评论

基本信息

Path： /api/admin/order-comments/reply

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	评论ID
reply_content	text	是	回复内容

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

隐藏评价

基本信息

Path： /api/admin/order-comments/show

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	16	评价id
is_show	text	是	1	0为隐藏 1为显示

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

用户列表

基本信息

Path： /api/admin/user/index

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
keyword	否	Andy	模糊搜索
sort	否	price_count_desc	price_count_desc 支付金额降序

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须
├─ nickname	string	非必须
├─ mobile	string	非必须
├─ member_level	string	非必须
├─ coupon_count	string	非必须
├─ order_count	string	非必须
├─ card_count	string	非必须
├─ created_at	string	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ mall_members	object []	非必须			item 类型: object
├─ id	number	必须
├─ mall_id	number	必须
├─ level	number	必须
├─ name	string	必须
├─ auto_update	number	必须
├─ money	string	必须
├─ discount	string	必须
├─ status	number	必须
├─ pic_url	string	必须
├─ is_purchase	number	必须
├─ price	string	必须
├─ rules	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	number	必须
├─ exportList	object []	非必须			item 类型: object
├─ key	string	必须
├─ value	string	必须

合伙人

基本信息

Path： /api/admin/share/index

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
keyword	是	Andy

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须
├─ mall_id	number	必须
├─ user_id	number	必须
├─ name	string	必须
├─ mobile	string	必须
├─ money	string	必须
├─ status	number	必须
├─ total_money	string	必须
├─ content	null	必须
├─ is_delete	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ apply_at	string	必须
├─ become_at	string	必须
├─ reason	string	必须
├─ first_children	number	必须
├─ all_children	number	必须
├─ all_money	string	必须
├─ all_order	number	必须
├─ nickname	string	必须
├─ avatar	string	必须
├─ parent_name	string	必须
├─ first	number	必须
├─ second	number	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ export_list	object []	非必须			item 类型: object
├─ key	string	必须
├─ value	string	必须

核销员列表

基本信息

Path： /api/admin/user/clerk

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ user_id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ card_count	string	必须
├─ order_count	string	必须
├─ user	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须
├─ store	object []	必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ name	string	必须
├─ mobile	string	必须
├─ address	string	必须
├─ province_id	string	必须
├─ city_id	string	必须
├─ district_id	string	必须
├─ longitude	string	必须
├─ latitude	string	必须
├─ score	string	必须
├─ cover_url	string	必须
├─ pic_url	string	必须
├─ business_hours	string	必须
├─ description	string	必须
├─ scope	string	必须
├─ is_default	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ total_price	number	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ store_list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ name	string	必须
├─ mobile	string	必须
├─ address	string	必须
├─ province_id	string	必须
├─ city_id	string	必须
├─ district_id	string	必须
├─ longitude	string	必须
├─ latitude	string	必须
├─ score	string	必须
├─ cover_url	string	必须
├─ pic_url	string	必须
├─ business_hours	string	必须
├─ description	string	必须
├─ scope	string	必须
├─ is_default	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须

用户积分充值/抵扣

基本信息

Path： /api/admin/user/integral

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Body

参数名称	参数类型	是否必须	示例	备注
user_id	text	是	61	用户id
num	text	是	100	积分数量
type	text	是	1	1为充值 0为扣除
remark	text	否		备注信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

用户余额充值/抵扣

基本信息

Path： /api/admin/user/balance

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
user_id	是	61	用户id
type	是	1	1为充值 0为扣除
price	是	100	金额
remark	否		备注信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

获取商城配置

基本信息

Path： /api/admin/mall/setting

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须		商城配置
├─ id	string	非必须
├─ name	string	非必须
├─ user_id	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_recycle	string	非必须
├─ is_disable	string	非必须
├─ option	object []	非必须			item 类型: object
├─ key	string	必须
├─ value	array,string,number	必须
├─ setting	object	非必须
├─ contact_tel	string	非必须
├─ over_time	number	非必须
├─ delivery_time	number	非必须
├─ after_sale_time	number	非必须
├─ payment_type	string []	非必须			item 类型: string
├─		非必须
├─ send_type	string	非必须
├─ kdniao_mch_id	string	非必须
├─ kdniao_api_key	string	非必须
├─ member_integral	string	非必须
├─ member_integral_rule	string	非必须
├─ good_negotiable	string []	非必须			item 类型: string
├─		非必须
├─ mobile_verify	string	非必须
├─ is_small_app	string	非必须
├─ small_app_id	string	非必须
├─ small_app_url	string	非必须
├─ small_app_pic	string	非必须
├─ is_customer_services	string	非必须
├─ customer_services_pic	string	非必须
├─ is_dial	string	非必须
├─ dial_pic	string	非必须
├─ is_web_service	string	非必须
├─ web_service_url	string	非必须
├─ web_service_pic	string	非必须
├─ is_quick_navigation	string	非必须
├─ quick_navigation_style	string	非必须
├─ quick_navigation_pic	string	非必须
├─ cat_style	string	非必须
├─ recommend_count	number	非必须
├─ cat_goods_count	number	非必须
├─ cat_goods_cols	number	非必须
├─ is_member_price	string	非必须
├─ is_share_price	string	非必须
├─ is_purchase_frame	string	非必须
├─ is_comment	string	非必须
├─ is_sales	string	非必须
├─ is_recommend	string	非必须
├─ is_mobile_auth	string	非必须
├─ is_official_account	string	非必须
├─ is_manual_mobile_auth	string	非必须
├─ is_quick_map	string	非必须
├─ quick_map_pic	string	非必须
├─ quick_map_address	string	非必须
├─ longitude_latitude	string	非必须
├─ is_quick_home	string	非必须
├─ quick_home_pic	string	非必须
├─ sms	object	非必须		短信配置
├─ status	string	非必须		短信配置状态
├─ platform	string	非必须
├─ access_key_id	string	非必须
├─ access_key_secret	string	非必须
├─ template_name	string	非必须
├─ order	object	非必须
├─ template_id	string	非必须
├─ template_variable	string	非必须
├─ order_refund	object	非必须
├─ template_id	string	非必须
├─ template_variable	string	非必须
├─ captcha	object	非必须
├─ template_id	string	非必须
├─ template_variable	string	非必须
├─ mail	object	非必须		邮件配置
├─ mall_id	number	非必须
├─ mch_id	number	非必须

入驻商/合伙人审核 列表

基本信息

Path： /api/admin/review/index

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
type	否	1	1为入驻商待审核列表 2为合伙人待审核列表（默认为1） 3为股东审核列表
page	否	1
keyword	否	维维

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ status	string	非必须
├─ is_recommend	string	非必须
├─ review_status	string	非必须
├─ review_remark	string	非必须
├─ review_time	string	非必须
├─ realname	string	非必须
├─ wechat	string	非必须
├─ mobile	string	非必须
├─ mch_common_cat_id	string	非必须
├─ transfer_rate	string	非必须
├─ account_money	string	非必须
├─ sort	string	非必须
├─ form_data	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ user	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须
├─ store	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ address	string	非必须
├─ province_id	string	非必须
├─ city_id	string	非必须
├─ district_id	string	非必须
├─ longitude	string	非必须
├─ latitude	string	非必须
├─ score	string	非必须
├─ cover_url	string	非必须
├─ pic_url	string	非必须
├─ business_hours	string	非必须
├─ description	string	非必须
├─ scope	string	非必须
├─ is_default	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

获取审核消息tab栏

基本信息

Path： /api/admin/review/tabs

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object []	非必须			item 类型: object
├─ typeid	number	必须
├─ type	string	必须

获取入驻商申请详情信息

基本信息

Path： /api/admin/review/detail

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
id	是	99	入驻商id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ status	string	非必须
├─ is_recommend	string	非必须
├─ review_status	string	非必须
├─ review_remark	string	非必须
├─ review_time	string	非必须
├─ realname	string	非必须
├─ wechat	string	非必须
├─ mobile	string	非必须
├─ mch_common_cat_id	string	非必须
├─ transfer_rate	string	非必须
├─ account_money	string	非必须
├─ sort	string	非必须
├─ form_data	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ user	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须
├─ mchUser	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ store	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ address	string	非必须
├─ province_id	string	非必须
├─ city_id	string	非必须
├─ district_id	string	非必须
├─ longitude	string	非必须
├─ latitude	string	非必须
├─ score	string	非必须
├─ cover_url	string	非必须
├─ pic_url	string	非必须
├─ business_hours	string	非必须
├─ description	string	非必须
├─ scope	string	非必须
├─ is_default	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ longitude_latitude	string	非必须
├─ address	string	非必须
├─ logo	string	非必须
├─ service_mobile	string	非必须
├─ bg_pic_url	object	非必须
├─ name	string	非必须
├─ description	string	非必须
├─ scope	string	非必须
├─ district	number []	非必须			item 类型: number
├─		非必须

入驻商/合伙人 审核通过/拒绝

基本信息

Path： /api/admin/review/switch-status

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
user_id	否	61	type为2时，必须
type	是	2	1为多商户 2为合伙人 3为股东（其他参数参考后台股东审核）
status	是	1为通过 0为拒绝

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

首页图表

基本信息

Path： /api/admin/data-statistics/table

Method： POST

接口描述：

同 数据统计-图表

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

订单列表/订单消息

基本信息

Path： /api/admin/order/index

Method： POST

接口描述：

订单消息跳转到订单列表的时候，带订单号过去直接查询，并根据状态如下进行状态显示
is_pay = 0  未付款
is_pay = 1 或者 pay_type = 2  已付款

售后消息跳转到售后列表

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
status	否		-1全部 0未付款 1待发货 2待收货 3已完成 4待处理/待退款/退款提醒 5已取消 7 回收站 8下单提醒
store_id	否		门店id
date_start	是		开始时间 y-m-sH:i:s
date_end	是
clerk_id	是		核销员id
user_id	是		用户id
is_offline	是		是否到店自提：0.否
keyword	是
keyword_1	是		1 订单号搜索 2 昵称搜索 3名称搜索4订单id搜索5 商品搜索6收件人号码搜索
plugin	否	all	all 全部订单

Body

参数名称	参数类型	是否必须	示例	备注
plugin	text	是	all	插件标识 all全部

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ mch_id	string	必须
├─ order_no	string	必须
├─ total_price	string	必须
├─ total_pay_price	string	必须
├─ express_price	string	必须
├─ total_goods_price	string	必须
├─ total_goods_original_price	string	必须
├─ member_discount_price	string	必须
├─ use_user_coupon_id	string	必须
├─ coupon_discount_price	string	必须
├─ use_integral_num	string	必须
├─ integral_deduction_price	string	必须
├─ name	string	必须
├─ mobile	string	必须
├─ address	string	必须
├─ remark	string	必须
├─ order_form	object,null	必须
├─ words	string	必须
├─ seller_remark	string	必须
├─ is_pay	string	必须
├─ pay_type	string	必须
├─ pay_time	string	必须
├─ is_send	string	必须
├─ send_time	string	必须
├─ express	string	必须
├─ express_no	string	必须
├─ is_sale	string	必须
├─ is_confirm	string	必须
├─ confirm_time	string	必须
├─ cancel_status	string	必须
├─ cancel_time	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_recycle	string	必须
├─ is_offline	string	必须
├─ offline_qrcode	string	必须
├─ clerk_id	string	必须
├─ store_id	string	必须
├─ token	string	必须
├─ nickname	string	必须		用户昵称
├─ detail	object []	必须		订单详情信息（备注见order_detail）	item 类型: object
├─ id	string	必须
├─ order_id	string	必须
├─ goods_id	string	必须
├─ num	string	必须
├─ unit_price	string	必须
├─ total_original_price	string	必须
├─ total_price	string	必须
├─ member_discount_price	string	必须
├─ goods_info	string	必须
├─ is_delete	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ goods	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ price	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ status	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ virtual_sales	string	非必须
├─ sort	string	非必须
├─ is_quick_shop	string	非必须
├─ is_sell_well	string	非必须
├─ is_level	string	非必须
├─ confine_count	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ is_negotiable	string	非必须
├─ freight_id	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ refund	null	必须		商品售后情况
├─ attr_list	object []	必须		商品规格	item 类型: object
├─ attr_group_name	string	必须		规格组
├─ attr_group_id	number,string	必须
├─ attr_id	number,string	必须
├─ attr_name	string	必须		规格名
├─ clerk	object	必须		核销人信息
├─ field_2	string	必须
├─ store	object	必须		门店信息
├─ exportList	string []	非必须		导出信息（未处理）	item 类型: string
├─		非必须

修改总价格

基本信息

Path： /api/admin/order/update-total-price

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
order_id	text	是		订单ID
mch_id	text	是
total_price	text	是		价格
express_price	text	是		运费

返回数据

名称	类型	是否必须	默认值	备注	其他信息

修改收货信息

基本信息

Path： /api/admin/order/update-address

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
order_id	text	是		订单ID
name	text	是		名字
mobile	text	是		手机
province	text	是		省
city	text	是		市
district	text	是		区
address	text	是		详细地址

收货地址列表

基本信息

Path： /api/admin/order/address-list

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

查看物流

基本信息

Path： /api/order/express-detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	否
express	是
express_no	是
customer_name	否		京东物流必填

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ order	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ mch_id	string	非必须
├─ order_no	string	非必须
├─ total_price	string	非必须
├─ total_pay_price	string	非必须
├─ express_original_price	string	非必须
├─ express_price	string	非必须
├─ total_goods_price	string	非必须
├─ total_goods_original_price	string	非必须
├─ member_discount_price	string	非必须
├─ use_user_coupon_id	string	非必须
├─ coupon_discount_price	string	非必须
├─ use_integral_num	string	非必须
├─ integral_deduction_price	string	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ address	string	非必须
├─ remark	string	非必须
├─ order_form	string	非必须
├─ words	string	非必须
├─ seller_remark	string	非必须
├─ is_pay	string	非必须
├─ pay_type	string	非必须
├─ pay_time	string	非必须
├─ is_send	string	非必须
├─ send_time	string	非必须
├─ express	string	非必须
├─ express_no	string	非必须
├─ is_sale	string	非必须
├─ is_confirm	string	非必须
├─ confirm_time	string	非必须
├─ cancel_status	string	非必须
├─ cancel_time	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_recycle	string	非必须
├─ is_offline	string	非必须
├─ offline_qrcode	string	非必须
├─ clerk_id	string	非必须
├─ store_id	string	非必须
├─ sign	string	非必须
├─ token	string	非必须
├─ support_pay_types	string	非必须
├─ is_comment	string	非必须
├─ comment_time	string	非必须
├─ sale_status	string	非必须
├─ status	string	非必须
├─ back_price	string	非必须
├─ detail	object []	非必须			item 类型: object
├─ id	string	非必须
├─ order_id	string	非必须
├─ goods_id	string	非必须
├─ num	string	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ member_discount_price	string	非必须
├─ goods_info	object	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ goods_attr	object	非必须
├─ id	number	非必须
├─ goods_id	number	非必须
├─ sign_id	string	非必须
├─ stock	number	非必须
├─ price	string	非必须
├─ original_price	string	非必须
├─ no	string	非必须
├─ weight	number	非必须
├─ pic_url	string	非必须
├─ share_commission_first	string	非必须
├─ share_commission_second	string	非必须
├─ share_commission_third	string	非必须
├─ member_price	null	非必须
├─ integral_price	null	非必须
├─ use_integral	null	非必须
├─ discount	string []	非必须			item 类型: string
├─		非必须
├─ extra	string []	非必须			item 类型: string
├─		非必须
├─ goods_warehouse_id	number	非必须
├─ name	string	非必须
├─ cover_pic	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_refund	string	非必须
├─ refund_status	string	非必须
├─ back_price	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ express	object	非必须		物流信息
├─ list	object []	非必须			item 类型: object
├─ datetime	string	非必须
├─ desc	string	非必须
├─ memo	null	非必须
├─ status	number	非必须
├─ status_text	string	非必须

取消订单

基本信息

Path： /api/admin/order/cancel

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
order_id	text	是		订单ID
mch_id	text	是
status	text	是		1 同意取消 2 拒绝
remark	text	是		备注

返回数据

名称	类型	是否必须	默认值	备注	其他信息

订单详情后台

基本信息

Path： /api/admin/order/detail

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
order_id	是	订单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ order	object	非必须		详见order表
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ mch_id	string	非必须
├─ order_no	string	非必须
├─ total_price	string	非必须
├─ total_pay_price	string	非必须
├─ express_price	string	非必须
├─ total_goods_price	string	非必须
├─ total_goods_original_price	string	非必须
├─ member_discount_price	string	非必须
├─ use_user_coupon_id	string	非必须
├─ coupon_discount_price	string	非必须
├─ use_integral_num	string	非必须
├─ integral_deduction_price	string	非必须
├─ name	string	非必须		收件人
├─ mobile	string	非必须		手机号码
├─ address	string	非必须		地址
├─ remark	string	非必须
├─ words	string	非必须		商家留言
├─ seller_remark	string	非必须		商家订单备注
├─ is_pay	string	非必须		是否支付：0.未支付|1.已支付
├─ pay_type	string	非必须
├─ pay_time	string	非必须		支付时间
├─ is_send	string	非必须
├─ send_time	string	非必须
├─ express	string	非必须
├─ express_no	string	非必须
├─ is_sale	string	非必须
├─ is_confirm	string	非必须
├─ confirm_time	string	非必须
├─ cancel_status	string	非必须
├─ cancel_time	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_recycle	string	非必须
├─ is_offline	string	非必须
├─ offline_qrcode	string	非必须
├─ clerk_id	string	非必须
├─ store_id	string	非必须
├─ token	string	非必须
├─ user	object	非必须		用户信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ detail	object []	非必须			item 类型: object
├─ id	string	非必须
├─ order_id	string	非必须
├─ goods_id	string	非必须
├─ num	string	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ member_discount_price	string	非必须
├─ goods_info	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ price	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ status	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	object []	非必须		商品轮播图	item 类型: object
├─ id	string	必须
├─ pic_url	string	必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ virtual_sales	string	非必须
├─ sort	string	非必须
├─ is_quick_shop	string	非必须
├─ is_sell_well	string	非必须
├─ is_level	string	非必须
├─ confine_count	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ is_negotiable	string	非必须
├─ freight_id	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ refund	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ order_detail_id	string	非必须
├─ order_no	string	非必须
├─ type	string	非必须
├─ refund_price	string	非必须
├─ remark	string	非必须
├─ pic_list	string	非必须
├─ status	string	非必须
├─ status_time	string	非必须
├─ refuse_remark	string	非必须
├─ is_send	string	非必须
├─ send_time	string	非必须
├─ express	string	非必须
├─ express_no	string	非必须
├─ address_id	string	非必须
├─ is_confirm	string	非必须
├─ confirm_time	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ attr_list	object []	非必须		规格信息	item 类型: object
├─ attr_group_name	string	必须		规格组
├─ attr_group_id	string,number	必须
├─ attr_id	string,number	必须
├─ attr_name	string	必须		规格名
├─ refund	string	非必须		售后状态
├─ order_form	string []	非必须		订单form（未处理）	item 类型: string
├─		非必须
├─ mch	string []	非必须		多商户（未处理）	item 类型: string
├─		非必须

售后列表/订单消息-售后

基本信息

Path： /api/admin/order/refund

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
status	是	0	-1全部 0未处理/售后消息 1 已处理 2代发货 3待收货
user_id	是
date_start	是
date_end	是
keyword	是
keyword_1	是		1 订单号搜索 2 昵称搜索 3名称搜索4订单id搜索5 6收件人号码搜索

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须		售后订单列表(详情见售后表)	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ order_id	string	必须
├─ order_detail_id	string	必须
├─ order_no	string	必须
├─ type	string	必须
├─ refund_price	string	必须
├─ remark	string	必须
├─ pic_list	string	必须
├─ status	string	必须
├─ status_time	string	必须
├─ merchant_remark	string	必须
├─ is_send	string	必须
├─ send_time	string	必须
├─ express	string	必须
├─ express_no	string	必须
├─ address_id	string	必须
├─ is_confirm	string	必须
├─ confirm_time	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ name	string	必须		收件人
├─ mobile	string	必须		电话号码
├─ address	string	必须		地址
├─ pay_type	string	必须		支付方式
├─ detail	object	必须		订单详情
├─ id	string	非必须
├─ order_id	string	非必须
├─ goods_id	string	非必须
├─ num	string	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ member_discount_price	string	非必须
├─ goods_info	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ price	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ status	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ virtual_sales	string	非必须
├─ sort	string	非必须
├─ is_quick_shop	string	非必须
├─ is_sell_well	string	非必须
├─ is_level	string	非必须
├─ confine_count	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ is_negotiable	string	非必须
├─ freight_id	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ address	object []	非必须		后台收货地址	item 类型: object
├─ id	number	必须
├─ mall_id	number	必须
├─ mch_id	number	必须
├─ name	string	必须
├─ address	string	必须
├─ mobile	string	必须
├─ remark	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	number	必须
├─ exportList	string []	非必须			item 类型: string
├─		非必须

售后处理

基本信息

Path： /api/admin/order/refund-handle

Method： POST

接口描述：

售后换货  无需物流 is_express=0  merchant_remark
                 需要物流 is_express=1 merchant_remark   express  express_no   merchant_remark

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
order_refund_id	text	是
type	text	是		1退货 2 换货
is_agree	text	是		1同意 0拒绝 2取消售后
refund	text	是		1退货 2退货退款
refund_price	text	是		退货价格 为空表示原支付价
address_id	text	是		地址ID
merchant_remark	text	是		商家同意
express	text	是		快递公司
express_no	text	是		快递单号
is_express	text	是		0无需物流 1需要

返回数据

名称	类型	是否必须	默认值	备注	其他信息

新增商品

基本信息

Path： /api/admin/goods/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Body

参数名称	参数类型	是否必须	示例	备注
form	text	是	{"attr":[{"id":1383,"goods_id":1028,"sign_id":"2:5","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":2,"attr_name":"红色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":5,"attr_name":"小"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1384,"goods_id":1028,"sign_id":"3:5","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":3,"attr_name":"黄色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":5,"attr_name":"小"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1385,"goods_id":1028,"sign_id":"4:5","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":4,"attr_name":"绿色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":5,"attr_name":"小"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1386,"goods_id":1028,"sign_id":"2:6","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":2,"attr_name":"红色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":6,"attr_name":"中"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1387,"goods_id":1028,"sign_id":"3:6","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":3,"attr_name":"黄色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":6,"attr_name":"中"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1388,"goods_id":1028,"sign_id":"4:6","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":4,"attr_name":"绿色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":6,"attr_name":"中"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1389,"goods_id":1028,"sign_id":"2:7","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":2,"attr_name":"红色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":7,"attr_name":"大"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1390,"goods_id":1028,"sign_id":"3:7","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":3,"attr_name":"黄色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":7,"attr_name":"大"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0},{"id":1391,"goods_id":1028,"sign_id":"4:7","stock":10,"price":"10.00","no":"10","weight":10,"pic_url":"","is_delete":0,"attr_list":[{"attr_group_name":"颜色","attr_group_id":1,"attr_id":4,"attr_name":"绿色"},{"attr_group_name":"大小","attr_group_id":2,"attr_id":7,"attr_name":"大"}],"member_price":{"level1":"0.00","level2":"0.00","level3":"0.00"},"share_commission_first":0,"share_commission_second":0,"share_commission_third":0}],"cats":[35,39,61],"mchCats":[],"cards":[],"services":[],"pic_url":[{"id":"546","pic_url":"http://v4test.zjhejiang.com/web/uploads/20190528/2247632a642b9924881d8715dd43b28e.gif"}],"use_attr":1,"goods_num":90,"status":1,"unit":"件","virtual_sales":555,"cover_pic":"http://v4test.zjhejiang.com/web/uploads/20190528/2247632a642b9924881d8715dd43b28e.gif","sort":100,"accumulative":0,"confine_count":-1,"forehead":"0.00","forehead_integral":0,"forehead_integral_type":1,"freight_id":0,"give_integral":0,"give_integral_type":1,"individual_share":0,"is_level":0,"is_level_alone":0,"pieces":0,"share_type":0,"attr_setting_type":0,"video_url":"","is_quick_shop":1,"is_sell_well":1,"is_negotiable":0,"share_commission_first":"0.00","share_commission_second":"0.00","share_commission_third":"0.00","name":"小鸡","price":"9.90","original_price":"5.00","cost_price":"2.00","detail":" jjj ","extra":"","app_share_title":"","app_share_pic":"","is_default_services":1,"member_price":{},"goods_no":"","goods_weight":"","select_attr_groups":[],"goodsWarehouse_attrGroups":[],"mall_id":2,"created_at":"2019-05-28 15:11:14","updated_at":"2019-05-29 10:05:56","deleted_at":"2019-05-29 10:05:56","is_delete":0,"mch_id":0,"goods_warehouse_id":98,"attr_groups":[{"attr_group_id":1,"attr_group_name":"颜色","attr_list":[{"attr_id":2,"attr_name":"红色"},{"attr_id":3,"attr_name":"黄色"},{"attr_id":4,"attr_name":"绿色"}]},{"attr_group_id":2,"attr_group_name":"大小","attr_list":[{"attr_id":5,"attr_name":"小"},{"attr_id":6,"attr_name":"中"},{"attr_id":7,"attr_name":"大"}]}],"goods_stock":90,"sign":"","payment_people":0,"payment_num":0,"payment_amount":"0.00","payment_order":0,"goods_warehouse":{"goods_id":1028,"name":"小鸡","original_price":"5.00","attr_groups":[{"attr_group_id":1,"attr_group_name":"颜色","attr_list":[{"attr_id":2,"attr_name":"红色"},{"attr_id":3,"attr_name":"黄色"},{"attr_id":4,"attr_name":"绿色"}]},{"attr_group_id":2,"attr_group_name":"大小","attr_list":[{"attr_id":5,"attr_name":"小"},{"attr_id":6,"attr_name":"中"},{"attr_id":7,"attr_name":"大"}]}]},"id":"1028"}	商品分类：cats 【请求获取分类列表接口】

商品名称：name
商品详情：detail
商品缩略图：cover_pic
单位：unit
原价：original_price
成本价：cost_price
规格组与规格值：attr
积分赠送:give_integral
积分抵扣：forehead_integral
单品满减包邮：pieces
单品满额包邮：forehead
限购数量：confine_count
运费设置：freight_id
商品服务：services 【请求获取商品服务列表接口】
卡券：cards 【请求获取商品卡券列表接口】 |
| attrGroups | text | 是 | [{"attr_group_id":1,"attr_group_name":"颜色","attr_list":[{"attr_id":2,"attr_name":"红色"},{"attr_id":3,"attr_name":"黄色"},{"attr_id":4,"attr_name":"绿色"}]},{"attr_group_id":2,"attr_group_name":"大小","attr_list":[{"attr_id":5,"attr_name":"小"},{"attr_id":6,"attr_name":"中"},{"attr_id":7,"attr_name":"大"}]}] | |

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

获取商品服务列表

基本信息

Path： /api/admin/service/options

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ name	string	必须
├─ is_default	string	必须

获取商品卡券列表

基本信息

Path： /api/admin/card/options

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ name	string	必须

获取商品分类列表

基本信息

Path： /api/admin/cat/options

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ value	string	必须
├─ label	string	必须
├─ children	object []	必须			item 类型: object
├─ value	string	必须
├─ label	string	必须
├─ children	object []	必须			item 类型: object
├─ value	string	必须
├─ label	string	必须

团队分红--插件

新增/编辑等级

基本信息

Path： /plugin/bonus/mall/members/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	否	1	等级id 有是修改，没有则新增
form[pic_url]	text	是	http://v4test2.zjhejiang.com/web/uploads/mall120/20190730/af580a4eb005460a7fda2cd14616535d.jpg	等级图
form[bg_pic_url]	text	是	http://v4test2.zjhejiang.com/web/uploads/mall120/20190730/af580a4eb005460a7fda2cd14616535d.jpg	等级背景图
form[level]	text	是	1	等级 1~100
form[name]	text	是	这是名称	等级名称
form[status]	text	是	1	状态 1为开 0为关
form[auto_update]	text	是	1	自动升级 1为开 0为关
form[rules]	text	是	啦啦啦啦啦	等级规则
form[rate]	text	是	5	分红比例
form[type]	text	是	2	升级条件类型 0:累计佣金 1:已提现佣金 2:下级总人数 3:下级合伙人数 4:下级队长数
form[condition]	text	是	500	升级条件

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

队长等级列表

基本信息

Path： /plugin/bonus/mall/members/index

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ level	string	非必须
├─ name	string	非必须
├─ auto_update	string	非必须
├─ update_type	string	非必须
├─ update_condition	string	非必须
├─ rate	string	非必须
├─ status	string	非必须
├─ pic_url	string	非必须
├─ rules	string	非必须
├─ bg_pic_url	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

前端发起提现

基本信息

Path： /plugin/bonus/api/index/cash

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
price	text	是	100	提现金额
type	text	是	auto	提现类型

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

前端获取团队分红设置

基本信息

Path： /plugin/bonus/api/index/setting

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

可用等级列表

基本信息

Path： /plugin/bonus/mall/members/options

Method： GET

接口描述：

disabled：true 则代表已经使用，不可选

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ name	string	必须
├─ level	number	必须
├─ disabled	boolean	必须

后台删除被拒绝的队长审核

基本信息

Path： /plugin/bonus/mall/captain/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
user_id	text	是	259

后台备注提现申请

基本信息

Path： /plugin/bonus/mall/cash/remark

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
remark	text	是	这是一条备注
id	text	是	1	提现id

返回数据

名称	类型	是否必须	默认值	备注	其他信息

后台审核打款拒绝提现

基本信息

Path： /plugin/bonus/mall/cash/cash-apply

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
id	是	1	提现id
status	是	1	1为审核通过 2为打款 3为拒绝
content	否	这是一条备注	status=3 时，必填

返回数据

名称	类型	是否必须	默认值	备注	其他信息

后台提现列表

基本信息

Path： /plugin/bonus/mall/cash/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
status	是	1	-1 为所有 0--申请 1--同意 2--已打款 3--驳回
date_start	是	2019-07-01 14	开始时间
date_end	是	2019-07-18 14	结束时间
keyword	是	259	关键词
search_type	是	4	与keyword共用， 1为搜索队长昵称 2队长姓名 3队长手机 4用户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
list	object []	非必须			item 类型: object
├─ id	number	非必须
├─ order_no	string	非必须
├─ pay_type	string	非必须
├─ type	string	非必须
├─ status	number	非必须
├─ status_text	string	非必须
├─ user	object	非必须
├─ avatar	string	非必须
├─ nickname	string	非必须
├─ platform	string	非必须
├─ cash	object	非必须
├─ price	number	非必须
├─ service_charge	number	非必须
├─ actual_price	number	非必须
├─ extra	object	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ bank_name	string	非必须
├─ time	object	非必须
├─ created_at	string	非必须
├─ apply_at	string	非必须
├─ remittance_at	string	非必须
├─ reject_at	string	非必须
├─ content	object	非必须
├─ apply_content	string	非必须
├─ remittance_content	string	非必须
├─ reject_content	string	非必须
pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
export_list	object []	非必须			item 类型: object
├─ key	string	必须
├─ value	string	必须

后台解除队长

基本信息

Path： /plugin/bonus/mall/captain/remove

Method： POST

接口描述：

返回一个队列id

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
user_id	text	是	280	用户id
reason	text	是	I like	解除原因

返回数据

名称	类型	是否必须	默认值	备注	其他信息

后台队长列表

基本信息

Path： /plugin/bonus/mall/captain/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
status	否	1	1通过 0审核中 2拒绝 3处理中
date_start	否	2019-07-01 14	开始时间
date_end	否	2019-07-18 14	结束时间
keyword	否	259	关键字
search_type	否	4	1为搜索队长昵称 2队长姓名 3队长手机 4用户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须
├─ mall_id	number	必须
├─ name	string	必须
├─ mobile	string	必须
├─ user_id	number	必须
├─ total_bonus	string	必须
├─ cash_bonus	string	必须
├─ expect_bonus	string	必须
├─ reason	string	必须
├─ remark	string	必须
├─ status	number	必须
├─ all_member	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ apply_at	string,null	必须
├─ is_delete	number	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ export_list	object []	非必须			item 类型: object
├─ key	string	必须
├─ value	string	必须

后台队长备注

基本信息

Path： /plugin/bonus/mall/captain/remark

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
user_id	text	是	259
remark	text	是	备注

后台队长审核

基本信息

Path： /plugin/bonus/mall/captain/apply

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
user_id	text	是	259
status	text	是	1	1通过 2拒绝
reason	text	是	原因	拒绝时必填，同意是填个“后台管理员审核通过”

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	number	非必须		队列id

获取等级

基本信息

Path： /plugin/bonus/mall/members/edit

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	等级id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ level	number	非必须
├─ name	string	非必须
├─ auto_update	string	非必须
├─ update_type	string	非必须
├─ update_condition	string	非必须
├─ rate	string	非必须
├─ status	string	非必须
├─ pic_url	string	非必须
├─ rules	string	非必须
├─ bg_pic_url	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须

团队分红设置

基本信息

Path： /plugin/bonus/mall/setting/index

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
is_bonus	text	是	1	1为开启 0为关闭
bonus_rate	text	是	5
become_type	text	是	1	1佣金总额 2已提现佣金总额 3下线认数 4下线合伙人数
condition	text	是	500	条件
is_agreement	text	是	1
agreement_title	text	是	哈哈
agreement_content	text	是	安德森高大上a
pay_type[0]	text	是	alipay
min_money	text	是	1
cash_service_charge	text	是	5
free_cash_min	text	是	1
free_cash_max	text	是	100
form[entry_bonus]	text	是	哈哈
form[title]	text	是	阿斯顿
form[count]	text	是	5
form[shares]	text	是	2
form[total_bonus]	text	是
form[expect_bonus]	text	是
form[cashd_bonus]	text	是
form[can_cash_bonus]	text	是
form[statistic_bonus]	text	是
form[statistic_total]	text	是
form[statistic_today]	text	是
form[statistic_seven_days]	text	是
form[statistic_one_month]	text	是
form[orders]	text	是
form[members]	text	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

分红订单/订单列表相关

基本信息

Path： /plugin/bonus/mall/order/index

Method： POST

接口描述：

出参参考http://106.14.190.102:3000/project/25/interface/api/609
新参数      "captain_name": "张大师",                    队长名
                "captain_mobile": "18899990000",        队长电话
                "bonus_price": "140000.00",                 分红金额
                "bonus_status": "1",                              分红状态  0预计分红，1完成分红，2分红失败

小程序端接口 /plugin/bonus/api/order/index

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
status	text	否		1未完成，2已完成
keyword	text	否		搜索词
keyword_1	text	否		1订单号，2昵称，3收件人，4用户ID，5商品名，6收货手机，7队长名
page	text	否		页码get传值
limit	text	否		每页数量
date_start	text	否		开始时间
date_end	text	否		结束时间
is_offline	text	是		1自提，2快递

返回数据

名称	类型	是否必须	默认值	备注	其他信息

查看审核状态

基本信息

Path： /plugin/bonus/api/index/apply-status

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ captain	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ user_id	number	非必须
├─ total_bonus	string	非必须
├─ cash_bonus	string	非必须
├─ expect_bonus	string	非必须
├─ reason	string	非必须
├─ remark	string	非必须
├─ status	number	非必须		0为申请中 1为审核通过 2为拒绝 3为审核处理中
├─ all_member	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ apply_at	string	非必须
├─ is_delete	number	非必须

查看是否符合申请要求

基本信息

Path： /plugin/bonus/api/index/index

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token		是	dhL-sV6nhteKmaV-Z72Nc02B2_Qz0Y_H

Query

参数名称	是否必须	示例	备注
_mall_id	是	120

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ total_money	string	非必须		后台配置的项
├─ pass	boolean	非必须		是否符合条件
├─ condition	number	非必须		条件

查询解除队长队列执行状态

基本信息

Path： /plugin/bonus/mall/captain/remove-status

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
queue_id	是	101046	队列id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	string	非必须

查询队长审核队列执行状态

基本信息

Path： /plugin/bonus/mall/captain/apply-status

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
queue_id	是	101046	队列id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	string	非必须

清除申请状态

基本信息

Path： /plugin/bonus/api/index/clear-apply

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

申请队长

基本信息

Path： /plugin/bonus/api/index/apply

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	dhL-sV6nhteKmaV-Z72Nc02B2_Qz0Y_H	是

Query

参数名称	是否必须	示例	备注
_mall_id	是	120

Body

参数名称	参数类型	是否必须	示例	备注
name	text	是	张三	姓名
mobile	text	是	13232323232	手机
is_agree	text	是	1	是否勾选协议 （如果后台设置关闭协议，前端默认帮用户填1）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

禁用或恢复

基本信息

Path： /plugin/bonus/mall/members/switch-status

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

移除等级

基本信息

Path： /plugin/bonus/mall/members/destroy

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

获取团队分红设置

基本信息

Path： /plugin/bonus/mall/setting/index

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object	非必须
├─ is_bonus	number	非必须
├─ bonus_rate	number	非必须
├─ become_type	number	非必须
├─ condition	number	非必须
├─ is_agreement	number	非必须
├─ agreement_title	string	非必须
├─ agreement_content	string	非必须
├─ pay_type	string []	非必须			item 类型: string
├─		非必须
├─ min_money	number	非必须
├─ cash_service_charge	number	非必须
├─ free_cash_min	number	非必须
├─ free_cash_max	number	非必须
├─ bg_url	string	非必须
├─ form	object	非必须
├─ entry_bonus	string	非必须
├─ title	string	非必须
├─ count	string	非必须
├─ shares	string	非必须
├─ total_bonus	string	非必须
├─ expect_bonus	string	非必须
├─ cashd_bonus	string	非必须
├─ can_cash_bonus	string	非必须
├─ statistic_bonus	string	非必须
├─ statistic_total	string	非必须
├─ statistic_today	string	非必须
├─ statistic_seven_days	string	非必须
├─ statistic_one_month	string	非必须
├─ orders	string	非必须
├─ members	string	非必须

获取所有等级

基本信息

Path： /plugin/bonus/mall/members/all-member

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须
├─ mall_id	number	必须
├─ level	number	必须
├─ name	string	必须
├─ auto_update	number	必须
├─ update_type	number	必须
├─ update_condition	string	必须
├─ rate	string	必须
├─ status	number	必须
├─ pic_url	string	必须
├─ rules	string	必须
├─ bg_pic_url	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	number	必须

订单详情

基本信息

Path： /plugin/bonus/mall/order/detail

Method： POST

接口描述：

出参参考http://106.14.190.102:3000/project/25/interface/api/577
新参数      "captain_name": "张大师",                    队长名
                "captain_mobile": "18899990000",        队长电话
                "bonus_price": "140000.00",                 分红金额
                "bonus_status": "1",                              分红状态  0预计分红，1完成分红，2分红失败

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
order_id	text	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

订单备注

基本信息

Path： /plugin/bonus/mall/order/remark

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
order_id	text	是
remark	text	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

团员列表

基本信息

Path： /plugin/bonus/mall/order/team-bonus

Method： POST

接口描述：

小程序端接口 /plugin/bonus/api/order/team-bonus

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
captain_id	text	是		队长ID
keyword_1	text	否		1昵称，2手机号，3用户ID
keyword	text	否		搜索词
order_by	text	否	bonus_price desc / bonus_price	排序

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ captain	object	非必须		队长资料
├─ user_id	string	非必须
├─ name	string	非必须		名字
├─ mobile	string	非必须		手机
├─ all_member	string	非必须		队员数量
├─ nickname	string	非必须		昵称
├─ avatar	string	非必须		头像
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ bonus_price	string	非必须		分红金额
├─ user_id	string	非必须		用户ID
├─ nickname	string	非必须		昵称
├─ mobile	string	非必须		手机
├─ avatar	string	非必须		头像
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

分红统计

基本信息

Path： /plugin/bonus/api/order/data

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ all_data	object	非必须		总览数据
├─ day_data	null	非必须		昨日
├─ day_7_data	string	非必须		7日
├─ month_12_data	string	非必须		12月
├─ list	object	非必须		数据列表
├─ day_list	object []	非必须		昨日24小时	item 类型: object
├─ created_at	number	必须
├─ bonus_price	string	必须
├─ day_7_list	object []	非必须		7日	item 类型: object
├─ created_at	string	必须
├─ bonus_price	string	必须
├─ month_12_list	object []	非必须		12月	item 类型: object
├─ created_at	string	必须
├─ bonus_price	string	必须

手机核销

核销订单列表

基本信息

Path： /plugin/clerk/api/index/order

Method： GET

接口描述：

出参参考http://106.14.190.102:3000/project/25/interface/api/609

请求参数

Query

参数名称	是否必须	示例	备注
is_clerk	是		1、已核销 2、未核销
keyword_1	是		1、订单号查询
keyword	是		查询字段

返回数据

名称	类型	是否必须	默认值	备注	其他信息

我的核销订单列表

基本信息

Path： /plugin/clerk/api/index/my-order

Method： GET

接口描述：

出参参考http://106.14.190.102:3000/project/25/interface/api/609

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

订单详情

基本信息

Path： /plugin/clerk/api/index/detail

Method： GET

接口描述：

出参参考http://106.14.190.102:3000/project/25/interface/api/577

请求参数

Query

参数名称	是否必须	示例	备注
order_id	是

订单核销

基本信息

Path： /plugin/clerk/api/index/order-clerk

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
order_id	text	是
clerk_remark	text	是		备注

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

核销卡卷列表

基本信息

Path： /plugin/clerk/api/index/card

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
is_clerk	是		1、已核销 2、未核销

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ name	string	必须		卡卷名
├─ pic_url	string	必须		卡卷图
├─ user_id	string	必须
├─ store_id	string	必须
├─ store_name	string	必须		店铺名
├─ nickname	string	必须		用户昵称
├─ platform	string	必须		所属APP
├─ is_use	string	必须		1核销 0未

我的核销卡卷列表

基本信息

Path： /plugin/clerk/api/index/my-card

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ name	string	必须		卡卷名
├─ pic_url	string	必须		卡卷图
├─ user_id	string	必须
├─ store_id	string	必须
├─ store_name	string	必须		店铺名
├─ nickname	string	必须		用户昵称
├─ platform	string	必须		所属APP

卡券详情

基本信息

Path： /card/user-card-detail_1563844552351

Method： GET

接口描述：

接口/card/user-card-detail

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
cardId	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ card	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ card_id	string	非必须
├─ name	string	非必须		卡券名称
├─ pic_url	string	非必须		卡券图片
├─ content	string	非必须		卡券内容
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ is_use	string	非必须		是否使用 0--未使用|1--已使用
├─ clerk_id	string	非必须		核销员ID
├─ store_id	string	非必须		核销门店ID
├─ clerked_at	string	非必须		核销时间
├─ order_id	string	非必须
├─ goods_id	string	非必须
├─ data	string	非必须
├─ clerk	null	非必须		核销员信息
├─ store	null	非必须		核销门店信息

卡券核销

基本信息

Path： /card/card-clerk_1563844558055

Method： GET

接口描述：

接口/card/card-clerk

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
cardId	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

核销统计

基本信息

Path： /plugin/clerk/api/index/statistics

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
key	是		0累计 1今日 -1昨日 7七日 30三十日，默认是累计数据

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ order_num_list	object []	非必须			item 类型: object
├─ time	string	必须
├─ num	string	必须
├─ order_price_list	object []	非必须			item 类型: object
├─ time	string	必须
├─ num	string	必须
├─ card_list	object []	非必须			item 类型: object
├─ time	string	必须
├─ num	string	必须

是否是平台核销员

基本信息

Path： /plugin/clerk/api/index/clerk-info

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ is_mall	string	非必须		true|false

扫码买单后台

买单设置优惠券列表

基本信息

Path： /scan_code_pay/mall/activity/coupons

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
page	是	1	分页
keyword	是	名称	优惠券名称搜索

返回数据

名称	类型	是否必须	默认值	备注	其他信息

买单设置会员列表

基本信息

Path： /scan_code_pay/mall/activity/members

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
page	是	1	分页
keyword	是	名称	会员名称搜索

返回数据

名称	类型	是否必须	默认值	备注	其他信息

买单设置列表

基本信息

Path： /scan_code_pay/mall/activity/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1	分页
keyword	是	名称	名称

返回数据

名称	类型	是否必须	默认值	备注	其他信息

买单设置删除

基本信息

Path： /scan_code_pay/mall/activity/destroy

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
page	是	1	分布
keyword	是	名称	名称

Body

参数名称	参数类型	是否必须	示例	备注
activity_id	text	是	1	活动ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

买单设置卡券列表

基本信息

Path： /scan_code_pay/mall/activity/cards

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
page	是	1	分页
keyword	是	名称	卡券名称搜索

返回数据

名称	类型	是否必须	默认值	备注	其他信息

买单设置新增|更新

基本信息

Path： /scan_code_pay/mall/activity/edit

Method： POST

接口描述：

{
    name: '测试',
    start_time: '2019-07-31 13:40:00',
    end_time: '2019-08-31 13:40:00',
    send_type: 1,
    rules: '',
    status: 1,
    groups: JSON.stringify([
        {
            name: '组1',
            members: [
                {
                    name: '等级1',
                    level: 1,
                },
            ],
            rules: [
                {
                    rules_type: 1,
                    consume_money: 300,
                    send_integral_num: 10,
                    integral_type: 1,
                    send_money: 10.12,
                    preferential_money: 20,
                    integral_deduction: 0,
                    integral_deduction_type: 1,
                    is_coupon: 1,
                    cards: [
                        {
                            send_num: 1,
                            card_id: 28,
                        },
                        {
                            send_num: 2,
                            card_id: 31,
                        }
                    ],
                    coupons: [
                        {
                            send_num: 1,
                            coupon_id: 155,
                        },
                        {
                            send_num: 2,
                            coupon_id: 154,
                        },
                    ]
                },
                {
                    rules_type: 1,
                    consume_money: 400,
                    send_integral_num: 10,
                    integral_type: 1,
                    send_money: 10.12,
                    preferential_money: 20,
                    integral_deduction: 0,
                    integral_deduction_type: 1,
                    is_coupon: 1,
                    cards: [
                        {
                            send_num: 1,
                            card_id: 28,
                        },
                        {
                            send_num: 3,
                            card_id: 31,
                        }
                    ],
                    coupons: [
                        {
                            send_num: 1,
                            coupon_id: 155,
                        },
                        {
                            send_num: 2,
                            coupon_id: 154,
                        },
                    ]
                },
            ]
        },
        {
            name: '组2',
            members: [
                {
                    name: '等级2',
                    level: 2,
                },
            ],
            rules: [
                {
                    rules_type: 1,
                    consume_money: 500,
                    send_integral_num: 10,
                    integral_type: 1,
                    send_money: 10.12,
                    preferential_money: 20,
                    integral_deduction: 0,
                    integral_deduction_type: 1,
                    is_coupon: 1,
                    cards: [
                        {
                            send_num: 1,
                            card_id: 31,
                        },
                        {
                            send_num: 2,
                            card_id: 35,
                        }
                    ],
                    coupons: [
                        {
                            send_num: 1,
                            coupon_id: 155,
                        },
                        {
                            send_num: 2,
                            coupon_id: 154,
                        },
                    ]
                },
                {
                    rules_type: 1,
                    consume_money: 600,
                    send_integral_num: 10,
                    integral_type: 1,
                    send_money: 10.12,
                    preferential_money: 20,
                    integral_deduction: 0,
                    integral_deduction_type: 1,
                    is_coupon: 1,
                    cards: [
                        {
                            send_num: 1,
                            card_id: 28,
                        },
                        {
                            send_num: 2,
                            card_id: 31,
                        }
                    ],
                    coupons: [
                        {
                            send_num: 1,
                            coupon_id: 155,
                        },
                        {
                            send_num: 2,
                            coupon_id: 154,
                        },
                    ]
                },
            ]
        },
    ])
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
activity_id	是	1	活动ID

Body

参数名称	参数类型	是否必须	示例	备注
id	text	否	1	更新时操作时 再传
name	text	是	活动设置名称	活动设置名称
start_time	text	是	2019-08-10 18:30:30	开始时间
end_time	text	是	2019-08-10 18:30:30	结束时间
send_type	text	是	1	活动类型 1.赠送所有规则
status	text	是	1	0.关闭
rules	text	是	哈哈哈	规则
groups	text	是	json	json格式 具体数据格式看最下面备注

返回数据

名称	类型	是否必须	默认值	备注	其他信息

买单设置更新状态

基本信息

Path： /scan_code_pay/mall/activity/switch-status

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
activity_id	是	1	活动ID

Body

参数名称	参数类型	是否必须	示例	备注
activity_id	text	是	1	活动ID
status	text	是	1	状态 0.状态

返回数据

名称	类型	是否必须	默认值	备注	其他信息

买单设置详情

基本信息

Path： /scan_code_pay/mall/activity/edit

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
activity_id	是	1	活动ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

扫码买单小程序端

扫码买单 取消订单

基本信息

Path： /plugin/scan_code_pay/api/order/cancel

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
order_id	text	是	1	订单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

扫码买单下单

基本信息

Path： /plugin/scan_code_pay/api/order/submit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
price	text	是	10	输入金额
coupon_id	text	是	0	未选择优惠券填写0
use_integral	text	是	1	是否使用积分抵扣0.否
remark	text	是	1	备注信息

扫码买单二维码

基本信息

Path： /plugin/scan_code_pay/api/index/qr-code

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
price	text	否	10.12	输入金额

扫码买单优惠券

基本信息

Path： /plugin/scan_code_pay/api/order/coupons

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
price	text	是	10.12	输入金额

返回数据

名称	类型	是否必须	默认值	备注	其他信息

扫码买单预览

基本信息

Path： /plugin/scan_code_pay/api/order/preview

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
price	text	是	10	输入金额
coupon_id	text	是	0	未选择优惠券填写0
use_integral	text	是	1	是否使用积分抵扣0.否

返回数据

名称	类型	是否必须	默认值	备注	其他信息

扫码买单首页

基本信息

Path： /plugin/scan_code_pay/api/index/index

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ activity	object	非必须		活动信息
├─ id	number	非必须		活动ID
├─ mall_id	number	非必须		商城ID
├─ name	string	非必须		活动名称
├─ start_time	string	非必须		活动开始时间
├─ end_time	string	非必须		活动结束时间
├─ send_type	number	非必须		1.赠送所有规则|2.赠送满足最高规则
├─ rules	string	非必须		买单规则
├─ status	number	非必须		是否启用0.否|1.是
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ integral	object	非必须
├─ member_integral	string	非必须		可抵扣积分
├─ member_integral_rule	string	非必须		积分使用规则
├─ user_integral_num	number	非必须		用户积分余额
├─ goods	object	非必须
├─ id	string	非必须		商品ID
├─ mall_id	string	非必须		商城ID
├─ mch_id	string	非必须		商户ID
├─ goods_warehouse_id	string	非必须		关联商品库ID
├─ status	string	非必须		上架状态：0=下架，1=上架
├─ price	string	非必须		售价
├─ use_attr	string	非必须		是否使用规格：0=不使用，1=使用
├─ attr_groups	string	非必须		商品规格组
├─ goods_stock	string	非必须		商品总库存（规格库存相加）
├─ virtual_sales	string	非必须		已出售量（虚拟销量）
├─ confine_count	string	非必须		购物数量限制
├─ pieces	string	非必须		单品满件包邮
├─ forehead	string	非必须		单口满额包邮
├─ freight_id	string	非必须		运费模板ID
├─ give_integral	string	非必须		赠送积分
├─ give_integral_type	string	非必须		赠送积分类型1.固定值 |2.百分比
├─ forehead_integral	string	非必须		可抵扣积分
├─ forehead_integral_type	string	非必须		可抵扣积分类型1.固定值 |2.百分比
├─ accumulative	string	非必须		允许多件累计折扣
├─ individual_share	string	非必须		是否单独合伙人设置：0=否，1=是
├─ attr_setting_type	string	非必须		合伙人设置类型 0.普通设置|1.详细设置
├─ is_level	string	非必须		是否享受会员价购买
├─ is_level_alone	string	非必须		是否单独设置会员价
├─ share_type	string	非必须		合伙人佣金配比 0--固定金额 1--百分比
├─ sign	string	非必须		商品标示用于区分商品属于什么模块
├─ app_share_pic	string	非必须		商品自定义分享图片
├─ app_share_title	string	非必须		商品自定义分享标题
├─ is_default_services	string	非必须		默认服务 0.否|1.是
├─ sort	string	非必须		商品排序
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须		统计 支付人数
├─ payment_num	string	非必须		统计 支付件数
├─ payment_amount	string	非必须		统计 支付金额
├─ payment_order	string	非必须		支付订单数
├─ confine_order_count	string	非必须		限制下单数量
├─ is_area_limit	string	非必须		是否单独区域购买
├─ area_limit	string	非必须		区域限制详情 json格式
├─ share_level_type	string	非必须		合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_id	string	非必须		自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ name	string	非必须		商品名称
├─ original_price	string	非必须		商品原价
├─ cover_pic	string	非必须		商品缩略图
├─ unit	string	非必须		商品单位
├─ detail	string	非必须		商品详情
├─ video_url	string	非必须		商品视频
├─ level_show	number	非必须		会员等级是否显示0.否|1.是
├─ is_sales	number	非必须		是否售后
├─ attr	object []	非必须			item 类型: object
├─ id	number	非必须
├─ goods_id	number	非必须
├─ sign_id	string	非必须
├─ stock	number	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	number	非必须
├─ pic_url	string	非必须
├─ is_delete	number	非必须
├─ setting	object	非必须
├─ id	number	非必须		设置ID
├─ mall_id	number	非必须		商城ID
├─ is_scan_code_pay	number	非必须		是否开启扫码买单
├─ payment_type	string []	非必须		支付方式online_pay 线上支付 |balance 余额支付|huodao 货到付款	item 类型: string
├─		非必须
├─ is_share	number	非必须		是否开启合伙人0.否|1.是
├─ is_sms	number	非必须		是否开启短信提醒0.否|1.是
├─ is_mail	number	非必须		是否开启邮件提醒0.否|1.是
├─ share_type	number	非必须		合伙人类型 1.百分比|2.固定金额
├─ share_commission_first	string	非必须		一级合伙人金额
├─ share_commission_second	string	非必须		二级合伙人金额
├─ share_commission_third	string	非必须		三级合伙人金额
├─ poster	object	非必须		自定义海报
├─ bg_pic	object	非必须		背景图
├─ url	string	非必须		背景图url
├─ is_show	number	非必须		是否显示0.否|1.是
├─ qr_code	object	非必须		二维码
├─ is_show	number	非必须		是否显示0.否|1.是
├─ size	number	非必须		大小
├─ top	number	非必须		距顶部距离
├─ left	number	非必须		距左侧距离
├─ type	number	非必须		类型
├─ file_type	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须

同城配送

后台设置

基本信息

Path： /mall/delivery/index

Method： POST

接口描述：

参数json对象值可根据前端需要更改

'is_open' => 0,//开关 1开0关
'is_superposition' => 0,//是否叠加 1叠加0不
'mobile' => '{{"name":"","mobile":""},{"name":"","mobile":""}}',
'price_mode' => '{"start_price":"0","start_distance":"0","add_distance":"0","add_price":"0","exceed":"0","fixed":"0"}',//计费方式
'web_key' => '',//高德key
'address' => '{"address":"","longitude":"","latitude":""}',//配送起点地址
'explain' => '',//配送说明（配送时间什么的）
'range'=>'{}'//经纬度划定范围

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须
├─ is_open	string	非必须		0关1开
├─ is_superposition	string	非必须		0关1开
├─ is_express	string	非必须		0关1开
├─ mobile	string	非必须		json对象
├─ price_mode	string	非必须		json对象
├─ web_key	string	非必须		高德key

编辑保存

基本信息

Path： /mall/delivery/edit

Method： POST

接口描述：

数据保存时的格式，决定查询返回数据格式

set_data[is_open]:1
set_data[is_superposition]:1
set_data[mobile]:{{"name":"水电费","mobile":"18877774444"},{"name":"互联网","mobile":"18857574747"}}
set_data[price_mode]:{"start_price":"0","start_distance":"0","add_distance":"0","add_price":"0","exceed":"0","fixed":"0"}
set_data[web_key]:adfadfafsdasdf
set_data[address]:{"address":"阿里山","longitude":"90.1274","latitude":"32.33"}
set_data[explain]:周六不送
set_data[range]:{}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
set_data	text	是	看备注👆

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

获取配送费

基本信息

Path： /api/express/delivery-price

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
distance	是		距离
num	是		商品数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ price	number	非必须

配送员信息

基本信息

Path： /mall/delivery/mobile

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ mobile	string	非必须

超级会员卡--插件

会员卡下单

基本信息

Path： /plugin/vip_card/api/order/submit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	21	子卡id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ pay_id	number	非必须

我的会员卡信息

基本信息

Path： /plugin/vip_card/api/index/index

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token		是	dhL-sV6nhteKmaV-Z72Nc02B2_Qz0Y_H

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ user	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须		商城id
├─ user_id	string	非必须		用户id
├─ main_id	string	非必须		主卡id
├─ detail_id	string	非必须		子卡id
├─ image_type	string	非必须		购买时的类型 0:指定商品类别 1:指定商品 2:全场通用
├─ image_type_info	object	非必须		购买时的类型详情
├─ goods	string []	非必须			item 类型: string
├─		非必须
├─ cats	string []	非必须			item 类型: string
├─		非必须
├─ all	boolean	非必须
├─ image_discount	string	非必须		购买时的折扣
├─ image_is_free_delivery	string	非必须		购买时是否包邮
├─ image_main_name	string	非必须		购买时的主卡名称
├─ image_name	string	非必须		购买时的子卡名称
├─ all_send	string	非必须		最后一次赠送记录
├─ data	null	非必须
├─ start_time	string	非必须		会员卡开始时间
├─ end_time	string	非必须		会员卡结束时间
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ order	object []	非必须		购买记录	item 类型: object
├─ created_at	string	非必须
├─ expire	string	非必须		有效期
├─ detail_name	string	非必须		子卡名称
├─ user_id	string	非必须		用户id
├─ detail_id	string	非必须		子卡id
├─ expire	number	非必须		有效天数
├─ image_type_info_detail	object	非必须
├─ cats	string []	非必须			item 类型: string
├─		非必须
├─ all	boolean	非必须

新的主卡权益接口

基本信息

Path： /plugin/vip_card/api/index/index-right

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	必须
msg	string	必须
data	object	必须
├─ right	object	非必须
├─ name	string	非必须		主卡名
├─ cover	string	非必须		主卡封面
├─ type_info	object	非必须
├─ goods	number []	非必须		指定商品id列表	item 类型: number
├─		非必须
├─ cats	string []	非必须		指定商品分类id列表	item 类型: string
├─		非必须
├─ all	boolean	非必须
├─ image_type_info_detail	object	非必须
├─ goods	object []	非必须		指定商品列表详情	item 类型: object
├─ name	string	必须		商品名
├─ id	number	必须		商品id
├─ sales	string	必须		商品出售量
├─ price	string	必须		商品价格
├─ cover_pic	string	必须		商品封面
├─ page_url	string	必须		跳转url
├─ cats	object []	非必须		指定商品分类列表详情	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ parent_id	string	必须
├─ name	string	必须
├─ pic_url	string	必须
├─ sort	string	必须
├─ big_pic_url	string	必须
├─ advert_pic	string	必须
├─ advert_url	string	必须
├─ status	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_show	string	必须
├─ advert_open_type	string	必须
├─ advert_params	string	必须
├─ value	string	必须
├─ label	string	必须

获取会员卡

基本信息

Path： /plugin/vip_card/api/index/card

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须		商城id
├─ name	string	非必须		会员卡名称
├─ cover	string	非必须		会员卡封面
├─ type	string	非必须		0:指定商品类别 1:指定商品 2:全场通用
├─ type_info	object	非必须		all为1则 全场通用，goods为指定商品，cats为指定分类
├─ goods	string []	非必须			item 类型: string
├─		非必须
├─ cats	string []	非必须			item 类型: string
├─		非必须
├─ all	boolean	非必须
├─ discount	string	非必须		折扣
├─ is_discount	string	非必须		是否享受折扣
├─ is_free_delivery	string	非必须		是否全场包邮
├─ status	string	非必须		默认 0
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ detail	object []	非必须		子卡详情	item 类型: object
├─ id	string	非必须		子卡id
├─ mall_id	string	非必须		商城id
├─ vip_id	string	非必须		主卡id
├─ name	string	非必须		子卡名称
├─ cover	string	非必须		子卡卡面
├─ expire_day	string	非必须		子卡有效期
├─ price	string	非必须		子卡价格
├─ num	string	非必须		子卡数量
├─ sort	string	非必须		排序
├─ send_integral_num	string	非必须		赠送积分
├─ send_integral_type	string	非必须		赠送积分类型 默认为固定值
├─ send_balance	string	非必须		赠送余额
├─ title	string	非必须		使用说明
├─ content	string	非必须		内容
├─ status	string	非必须		状态默认为1
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ cards	string []	非必须		赠送卡券	item 类型: string
├─		非必须
├─ vipCards	string []	非必须		赠送卡券关联数据	item 类型: string
├─		非必须
├─ coupons	string []	非必须		赠送优惠券	item 类型: string
├─		非必须
├─ vipCoupons	string []	非必须		赠送优惠券关联数据	item 类型: string
├─		非必须
├─ type_info_detail	object	非必须
├─ goods	string []	非必须			item 类型: string
├─		非必须
├─ cats	string []	非必须			item 类型: string
├─		非必须
├─ all	boolean	非必须

获取会员卡设置

基本信息

Path： /plugin/vip_card/api/index/setting

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	必须
data	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须		商城id
├─ is_vip_card	number	非必须		SVIP会员卡开关
├─ payment_type	string []	非必须		支付类型	item 类型: string
├─		非必须
├─ is_share	number	非必须		是否开启合伙人 0关闭 1开启
├─ is_sms	number	非必须		是否开启短信 0关闭 1开启
├─ is_mail	number	非必须		是否开启邮件 0关闭 1开启
├─ is_agreement	number	非必须		是否显示协议 0关闭 1开启
├─ agreement_title	string	非必须		协议名称
├─ agreement_content	string	非必须		协议内容
├─ is_buy_become_share	number	非必须		购买成为合伙人 0关闭 1开启
├─ share_type	number	非必须		合伙人佣金类型 0百分比 1固定金额
├─ share_commission_first	string	非必须		一级合伙人比例
├─ share_commission_second	string	非必须		二级合伙人比例
├─ share_commission_third	string	非必须		三级合伙人比例
├─ form	object	非必须		自定义表单
├─ buy_big_color	string	非必须		未购买用户大标题颜色
├─ buy_small_color	string	非必须		未购买用户小标题颜色
├─ buy_btn_color	string	非必须		未购买用户按钮颜色
├─ buy_btn_bg_color	string	非必须		未购买用户按钮背景颜色
├─ buy_big	string	非必须		为购买用户大标题
├─ buy_small	string	非必须		为购买用户小标题
├─ buy_btn_text	string	非必须		未购买用户按钮文字
├─ renew_text_color	string	非必须		已购买用户文字颜色
├─ renew_btn_bg_color	string	非必须		已购买用户按钮背景颜色
├─ renew_text	string	非必须		已购买用户文字
├─ card_bg	string	非必须		卡面背景图
├─ card_color	string	非必须		卡面颜色
├─ vip_bg	string	非必须
├─ vip_color	string	非必须
├─ vip_number	number	非必须
├─ vip_line	number	非必须
├─ is_vip_scroll	number	非必须
├─ vip_icon_list	array []	非必须			item 类型: array
├─		非必须
├─		非必须
├─ right_list	object []	非必须			item 类型: object
├─ img	string	非必须
├─ big	string	非必须
├─ big_color	string	非必须
├─ small	string	非必须
├─ small_color	string	非必须
├─ rubik	object	非必须
├─ height	number	非必须
├─ list	string []	非必须			item 类型: string
├─		非必须
├─ bottom_style_1	string	非必须
├─ bottom_style_2	string	非必须
├─ bottom_btn_style_1	string	非必须
├─ bottom_btn_style_2	string	非必须
├─ sort	string []	非必须			item 类型: string
├─		非必须
├─ head_card	string	非必须
├─ buy_bg	string	非必须
├─ renew_bg	string	非必须
├─ integral_icon	string	非必须
├─ card_icon	string	非必须
├─ coupon_icon	string	非必须
├─ balance_icon	string	非必须
├─ is_sms	number	非必须
├─ rules	string []	非必须		规则	item 类型: string
├─		非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ name	string	非必须		会员卡名称
msg	string	非必须

获取子卡详情

基本信息

Path： /plugin/vip_card/api/index/card-detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	21	子卡id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ vip_id	string	非必须
├─ name	string	非必须
├─ expire_day	string	非必须
├─ price	string	非必须
├─ num	string	非必须
├─ send_integral_num	string	非必须
├─ send_integral_type	string	非必须
├─ send_balance	string	非必须
├─ title	string	非必须
├─ content	string	非必须
├─ status	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ cards	object []	非必须			item 类型: object
├─ id	string	非必须
├─ detail_id	string	非必须
├─ card_id	string	非必须
├─ send_num	string	非必须
├─ is_delete	string	非必须
├─ vipCards	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ pic_url	string	非必须
├─ description	string	非必须
├─ expire_type	string	非必须
├─ expire_day	string	非必须
├─ begin_time	string	非必须
├─ end_time	string	非必须
├─ total_count	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ coupons	object []	非必须			item 类型: object
├─ id	string	非必须
├─ detail_id	string	非必须
├─ coupon_id	string	非必须
├─ send_num	string	非必须
├─ is_delete	string	非必须
├─ vipCoupons	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ type	string	非必须
├─ discount	string	非必须
├─ pic_url	string	非必须
├─ desc	string	非必须
├─ min_price	string	非必须
├─ sub_price	string	非必须
├─ total_count	string	非必须
├─ sort	string	非必须
├─ expire_type	string	非必须
├─ expire_day	string	非必须
├─ begin_time	string	非必须
├─ end_time	string	非必须
├─ appoint_type	string	非必须
├─ rule	string	非必须
├─ is_member	string	非必须
├─ is_delete	string	非必须
├─ deleted_at	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

预览会员卡

基本信息

Path： /plugin/vip_card/api/order/preview

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ cover	string	非必须
├─ type	string	非必须
├─ type_info	string	非必须
├─ discount	string	非必须
├─ is_discount	string	非必须
├─ is_free_delivery	string	非必须
├─ status	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ detail	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ vip_id	string	非必须
├─ name	string	非必须
├─ expire_day	string	非必须
├─ price	string	非必须
├─ num	string	非必须
├─ send_integral_num	string	非必须
├─ send_integral_type	string	非必须
├─ send_balance	string	非必须
├─ title	string	非必须
├─ content	string	非必须
├─ status	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ vipCards	object []	非必须			item 类型: object
├─ id	string	非必须
├─ detail_id	string	非必须
├─ card_id	string	非必须
├─ send_num	string	非必须
├─ is_delete	string	非必须
├─ cards	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ pic_url	string	非必须
├─ description	string	非必须
├─ expire_type	string	非必须
├─ expire_day	string	非必须
├─ begin_time	string	非必须
├─ end_time	string	非必须
├─ total_count	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ vipCoupons	object []	非必须			item 类型: object
├─ id	string	非必须
├─ detail_id	string	非必须
├─ coupon_id	string	非必须
├─ send_num	string	非必须
├─ is_delete	string	非必须
├─ coupons	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ type	string	非必须
├─ discount	string	非必须
├─ pic_url	string	非必须
├─ desc	string	非必须
├─ min_price	string	非必须
├─ sub_price	string	非必须
├─ total_count	string	非必须
├─ sort	string	非必须
├─ expire_type	string	非必须
├─ expire_day	string	非必须
├─ begin_time	string	非必须
├─ end_time	string	非必须
├─ appoint_type	string	非必须
├─ rule	string	非必须
├─ is_member	string	非必须
├─ is_delete	string	非必须
├─ deleted_at	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

预售--插件

分享海报

基本信息

Path： /plugin/advance/api/goods/poster

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
goods_id	是	39590	预售商品id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pic_url	string	非必须

商品列表

基本信息

Path： /plugin/advance/api/goods/index

Method： GET

接口描述：

其他参数同商品，唯独attr下规格有不同参数，定金及膨胀金

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	number	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ attr	object []	非必须			item 类型: object
├─ id	string	非必须
├─ goods_id	string	非必须
├─ sign_id	string	非必须
├─ stock	string	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	string	非必须
├─ pic_url	string	非必须
├─ is_delete	string	非必须
├─ deposit	string	非必须		定金
├─ swell_deposit	string	非必须		膨胀金
├─ advanceGoods	object	非必须
├─ id	string	非必须
├─ goods_id	string	非必须
├─ mall_id	string	非必须
├─ ladder_rules	string	非必须
├─ deposit	string	非必须
├─ swell_deposit	string	非必须
├─ start_prepayment_at	string	非必须
├─ end_prepayment_at	string	非必须
├─ pay_limit	string	非必须
├─ is_delete	string	非必须
├─ cover_pic	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

商品详情

基本信息

Path： /plugin/advance/api/goods/detail

Method： GET

接口描述：

其他参数同商品，唯独attr下规格有不同参数，定金及膨胀金

请求参数

Query

参数名称	是否必须	示例	备注
id	是		商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ mch_id	number	非必须
├─ goods_warehouse_id	number	非必须
├─ status	number	非必须
├─ price	string	非必须
├─ use_attr	number	非必须
├─ attr_groups	object []	非必须			item 类型: object
├─ attr_group_id	number	非必须
├─ attr_group_name	string	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ goods_stock	number	非必须
├─ virtual_sales	number	非必须
├─ confine_count	number	非必须
├─ pieces	number	非必须
├─ forehead	string	非必须
├─ freight_id	number	非必须
├─ give_integral	number	非必须
├─ give_integral_type	number	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	number	非必须
├─ accumulative	number	非必须
├─ individual_share	number	非必须
├─ attr_setting_type	number	非必须
├─ is_level	number	非必须
├─ is_level_alone	number	非必须
├─ share_type	number	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	number	非必须
├─ sort	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ payment_people	number	非必须
├─ payment_num	number	非必须
├─ payment_amount	string	非必须
├─ payment_order	number	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cover_pic	string	非必须
├─ unit	string	非必须
├─ detail	string	非必须
├─ video_url	string	非必须
├─ level_show	number	非必须
├─ is_sales	number	非必须
├─ attr	object []	非必须			item 类型: object
├─ id	string	非必须
├─ goods_id	number	非必须
├─ sign_id	string	非必须
├─ stock	string	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	number	非必须
├─ pic_url	string	非必须
├─ is_delete	number	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ price_member	number	非必须
├─ member_price_list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ level	number	非必须
├─ price	string	非必须
├─ goods_attr_id	number	非必须
├─ is_delete	number	非必须
├─ goods_id	number	非必须
├─ deposit	string	非必须		定金
├─ swell_deposit	string	非必须		膨胀金
├─ extra	object []	非必须			item 类型: object
├─ value	string	必须
├─ name	string	必须
├─ goods_num	number	非必须
├─ goods_no	string	非必须
├─ goods_weight	number	非必须
├─ services	string []	非必须			item 类型: string
├─		非必须
├─ cards	string []	非必须			item 类型: string
├─		非必须
├─ price_min	number	非必须
├─ price_max	number	非必须
├─ pic_url	object []	非必须			item 类型: object
├─ id	string	非必须
├─ pic_url	string	非必须
├─ share	number	非必须
├─ sales	number	非必须
├─ favorite	boolean	非必须
├─ goods_marketing	object	非必须
├─ limit	string	非必须
├─ pickup	string	非必须
├─ shipping	string	非必须
├─ goods_marketing_award	object	非必须
├─ card	object	非必须
├─ title	string	非必须
├─ list	string []	非必须			item 类型: string
├─		非必须
├─ integral	object	非必须
├─ title	string	非必须
├─ integralMallGoods	object	非必须
├─ id	string	非必须
├─ goods_id	number	非必须
├─ mall_id	number	非必须
├─ ladder_rules	string	非必须
├─ deposit	string	非必须
├─ swell_deposit	string	非必须
├─ start_prepayment_at	string	非必须
├─ end_prepayment_at	string	非必须
├─ pay_limit	number	非必须
├─ is_delete	number	非必须

定金付款

基本信息

Path： /plugin/advance/api/order/advance

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
goods_id	text	是		商品ID
goods_attr_id	text	是		商品规格ID
goods_num	text	是		商品数量
id	text	否		重新付款时需要传

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ id	number	非必须

首页轮播图

基本信息

Path： /plugin/advance/api/goods/banner

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ pic_url	string	必须
├─ title	string	必须
├─ page_url	string	必须
├─ open_type	string	必须
├─ params	string	必须
├─ is_delete	string	必须
├─ created_at	string	必须
├─ deleted_at	string	必须
├─ updated_at	string	必须

礼物--插件

海报

基本信息

Path： /plugin/gift/api/gift-index/poster

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
gift_id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pic_url	string	必须		海报URL

后台--基本设置

基本信息

Path： /plugin/gift/mall/setting/index

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ title	string	非必须		页面标题
├─ type	string	非必须		选择玩法
├─ auto_refund	number	非必须		自动退款
├─ auto_remind	number	非必须		送礼未成功自动提醒
├─ bless_word	string	非必须		祝福语
├─ ask_gift	string	非必须		求礼物话术语
├─ is_sms	number	非必须		短信
├─ is_mail	number	非必须		邮件
├─ is_print	number	非必须		打印
├─ payment_type	string []	非必须		支付方式	item 类型: string
├─		非必须
├─ poster	object	非必须
├─ bg_pic	object	非必须
├─ url	string	非必须
├─ pic	object	非必须
├─ is_show	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_type	string	非必须
├─ head	object	非必须
├─ is_show	number	非必须
├─ size	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_type	string	非必须
├─ poster_bg	object	非必须
├─ is_show	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_path	string	非必须
├─ file_type	string	非必须
├─ qr_code	object	非必须
├─ is_show	number	非必须
├─ size	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ type	number	非必须
├─ file_path	string	非必须
├─ file_type	string	非必须
├─ nickname	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ nickname_share	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ name	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ desc	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ price	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ color	string	非必须
├─ text	string	非必须
├─ file_type	string	非必须

填写地址预览

基本信息

Path： /plugin/gift/api/gift-order/gift-convert-preview

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
form_data	是	{"list":[{"mch_id":0,"goods_list":[],"use_integral":0,"user_coupon_id":0,"distance":0,"remark":"","order_form":[]}],"address_id":0}

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ mch_list	object []	非必须			item 类型: object
├─ mch	object	非必须
├─ id	number	非必须
├─ name	string	非必须
├─ goods_list	string []	非必须			item 类型: string
├─		非必须
├─ form_data	object	非必须
├─ mch_id	number	非必须
├─ goods_list	string []	非必须			item 类型: string
├─		非必须
├─ use_integral	number	非必须
├─ user_coupon_id	number	非必须
├─ distance	number	非必须
├─ remark	string	非必须
├─ order_form	string []	非必须			item 类型: string
├─		非必须
├─ express_price	string	非必须
├─ remark	string	非必须
├─ order_form_data	string []	非必须			item 类型: string
├─		非必须
├─ total_goods_price	string	非必须
├─ total_goods_original_price	string	非必须
├─ member_discount	string	非必须
├─ coupon	object	非必须
├─ enabled	boolean	非必须
├─ use	boolean	非必须
├─ coupon_discount	string	非必须
├─ user_coupon_id	number	非必须
├─ coupon_error	null	非必须
├─ integral	object	非必须
├─ can_use	boolean	非必须
├─ use	boolean	非必须
├─ use_num	number	非必须
├─ deduction_price	string	非必须
├─ delivery	object	非必须
├─ send_type	string	非必须
├─ disabled	boolean	非必须
├─ send_type_list	object []	非必须			item 类型: object
├─ name	string	必须
├─ value	string	必须
├─ store	null	非必须
├─ store_select_enable	boolean	非必须
├─ city	object	非必须
├─ error	string	非必须
├─ total_price	string	非必须
├─ total_price	string	非必须
├─ price_enable	boolean	非必须
├─ address	null	非必须
├─ address_enable	boolean	非必须
├─ has_ziti	boolean	非必须
├─ custom_currency_all	string []	非必须			item 类型: string
├─		非必须
├─ allZiti	boolean	非必须
├─ hasCity	boolean	非必须

我参与的列表/详情

基本信息

Path： /plugin/gift/api/order-list/join-list

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ gift_id	string	非必须
├─ is_turn	string	非必须
├─ turn_no	string	非必须
├─ turn_user_id	string	非必须
├─ is_receive	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_win	string	非必须
├─ token	string	非必须
├─ giftLog	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ num	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_confirm	string	非必须
├─ type	string	非必须
├─ open_time	string	非必须
├─ open_num	string	非必须
├─ open_type	string	非必须
├─ bless_word	string	非必须
├─ auto_refund_time	string	非必须
├─ sendOrder	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ user_id	string	非必须
├─ gift_id	string	非必须
├─ order_no	string	非必须
├─ total_price	string	非必须
├─ total_pay_price	string	非必须
├─ is_pay	string	非必须
├─ pay_type	string	非必须
├─ pay_time	string	非必须
├─ is_refund	string	非必须
├─ is_confirm	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ support_pay_types	string	非必须
├─ token	string	非必须
├─ detail	object []	非必须			item 类型: object
├─ id	string	非必须
├─ send_order_id	string	非必须
├─ goods_id	string	非必须
├─ goods_attr_id	string	非必须
├─ goods_info	string	非必须
├─ num	string	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ is_refund	string	非必须
├─ refund_status	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ receive_num	string	非必须
├─ refund_price	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	null	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ giftOrder	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ order_no	string	非必须
├─ goods_id	string	非必须
├─ goods_attr_id	string	非必须
├─ num	string	非必须
├─ order_id	string	非必须
├─ type	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ user_order_id	string	非必须
├─ is_refund	string	非必须
├─ order	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ mch_id	string	非必须
├─ order_no	string	非必须
├─ total_price	string	非必须
├─ total_pay_price	string	非必须
├─ express_original_price	string	非必须
├─ express_price	string	非必须
├─ total_goods_price	string	非必须
├─ total_goods_original_price	string	非必须
├─ member_discount_price	string	非必须
├─ use_user_coupon_id	string	非必须
├─ coupon_discount_price	string	非必须
├─ use_integral_num	string	非必须
├─ integral_deduction_price	string	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ address	string	非必须
├─ remark	string	非必须
├─ order_form	string	非必须
├─ words	string	非必须
├─ seller_remark	string	非必须
├─ is_pay	string	非必须
├─ pay_type	string	非必须
├─ pay_time	string	非必须
├─ is_send	string	非必须
├─ send_time	string	非必须
├─ customer_name	string	非必须
├─ express	string	非必须
├─ express_no	string	非必须
├─ is_sale	string	非必须
├─ is_confirm	string	非必须
├─ confirm_time	string	非必须
├─ cancel_status	string	非必须
├─ cancel_time	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_recycle	string	非必须
├─ send_type	string	非必须
├─ offline_qrcode	string	非必须
├─ clerk_id	string	非必须
├─ store_id	string	非必须
├─ sign	string	非必须
├─ token	string	非必须
├─ support_pay_types	string	非必须
├─ is_comment	string	非必须
├─ comment_time	string	非必须
├─ sale_status	string	非必须
├─ status	string	非必须
├─ back_price	string	非必须
├─ auto_cancel_time	string	非必须
├─ auto_confirm_time	null	非必须
├─ auto_sales_time	null	非必须
├─ distance	string	非必须
├─ city_mobile	string	非必须
├─ location	null	非必须
├─ city_name	null	非必须
├─ city_info	null	非必须
├─ store	null	非必须
├─ detail	object []	非必须			item 类型: object
├─ id	string	非必须
├─ order_id	string	非必须
├─ goods_id	string	非必须
├─ num	string	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ member_discount_price	string	非必须
├─ goods_info	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_refund	string	非必须
├─ refund_status	string	非必须
├─ back_price	string	非必须
├─ sign	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	null	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ orderRefund	null	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	null	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ goodsAttr	object	非必须
├─ id	string	非必须
├─ goods_id	string	非必须
├─ sign_id	string	非必须
├─ stock	string	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	string	非必须
├─ pic_url	string	非必须
├─ is_delete	string	非必须
├─ sendUser	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ status	string	非必须
├─ status_num	number	非必须
├─ detail	object []	非必须			item 类型: object
├─ refund	number	非必须		-1不可换货0可以1换货中
├─ detail_id	string	非必须		订单详情ID
├─ name	string	非必须		商品名
├─ cover_pic	string	非必须		商品图
├─ num	string	非必须		数量
├─ attr	string	非必须		规格
├─ goods_id	integer	必须
├─ goods_attr_id	integer	必须
├─ goods_info	string []	必须			item 类型: string
├─		非必须
├─ order_no	string	非必须		订单号
├─ is_big_gift	number	非必须		是否是大礼包1是0否
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

我收到的列表/详情

基本信息

Path： /plugin/gift/api/order-list/win-list

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ gift_id	string	非必须
├─ is_turn	string	非必须
├─ turn_no	string	非必须
├─ turn_user_id	string	非必须
├─ is_receive	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_win	string	非必须
├─ token	string	非必须
├─ giftLog	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ num	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_confirm	string	非必须
├─ type	string	非必须
├─ open_time	string	非必须
├─ open_num	string	非必须
├─ open_type	string	非必须
├─ bless_word	string	非必须
├─ auto_refund_time	string	非必须
├─ sendOrder	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ user_id	string	非必须
├─ gift_id	string	非必须
├─ order_no	string	非必须
├─ total_price	string	非必须
├─ total_pay_price	string	非必须
├─ is_pay	string	非必须
├─ pay_type	string	非必须
├─ pay_time	string	非必须
├─ is_refund	string	非必须
├─ is_confirm	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ support_pay_types	string	非必须
├─ token	string	非必须
├─ detail	object []	非必须			item 类型: object
├─ id	string	非必须
├─ send_order_id	string	非必须
├─ goods_id	string	非必须
├─ goods_attr_id	string	非必须
├─ goods_info	string	非必须
├─ num	string	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ is_refund	string	非必须
├─ refund_status	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ receive_num	string	非必须
├─ refund_price	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	null	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ giftOrder	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ order_no	string	非必须
├─ goods_id	string	非必须
├─ goods_attr_id	string	非必须
├─ num	string	非必须
├─ order_id	string	非必须
├─ type	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ user_order_id	string	非必须
├─ is_refund	string	非必须
├─ order	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ mch_id	string	非必须
├─ order_no	string	非必须
├─ total_price	string	非必须
├─ total_pay_price	string	非必须
├─ express_original_price	string	非必须
├─ express_price	string	非必须
├─ total_goods_price	string	非必须
├─ total_goods_original_price	string	非必须
├─ member_discount_price	string	非必须
├─ use_user_coupon_id	string	非必须
├─ coupon_discount_price	string	非必须
├─ use_integral_num	string	非必须
├─ integral_deduction_price	string	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ address	string	非必须
├─ remark	string	非必须
├─ order_form	string	非必须
├─ words	string	非必须
├─ seller_remark	string	非必须
├─ is_pay	string	非必须
├─ pay_type	string	非必须
├─ pay_time	string	非必须
├─ is_send	string	非必须
├─ send_time	string	非必须
├─ customer_name	string	非必须
├─ express	string	非必须
├─ express_no	string	非必须
├─ is_sale	string	非必须
├─ is_confirm	string	非必须
├─ confirm_time	string	非必须
├─ cancel_status	string	非必须
├─ cancel_time	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_recycle	string	非必须
├─ send_type	string	非必须
├─ offline_qrcode	string	非必须
├─ clerk_id	string	非必须
├─ store_id	string	非必须
├─ sign	string	非必须
├─ token	string	非必须
├─ support_pay_types	string	非必须
├─ is_comment	string	非必须
├─ comment_time	string	非必须
├─ sale_status	string	非必须
├─ status	string	非必须
├─ back_price	string	非必须
├─ auto_cancel_time	string	非必须
├─ auto_confirm_time	null	非必须
├─ auto_sales_time	null	非必须
├─ distance	string	非必须
├─ city_mobile	string	非必须
├─ location	null	非必须
├─ city_name	null	非必须
├─ city_info	null	非必须
├─ store	null	非必须
├─ detail	object []	非必须			item 类型: object
├─ id	string	非必须
├─ order_id	string	非必须
├─ goods_id	string	非必须
├─ num	string	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ member_discount_price	string	非必须
├─ goods_info	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_refund	string	非必须
├─ refund_status	string	非必须
├─ back_price	string	非必须
├─ sign	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	null	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ orderRefund	null	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	null	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ goodsAttr	object	非必须
├─ id	string	非必须
├─ goods_id	string	非必须
├─ sign_id	string	非必须
├─ stock	string	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	string	非必须
├─ pic_url	string	非必须
├─ is_delete	string	非必须
├─ sendUser	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ status	string	非必须
├─ status_num	number	非必须
├─ detail	object []	非必须			item 类型: object
├─ refund	number	非必须		-1不可换货0可以1换货中
├─ detail_id	string	非必须		订单详情ID
├─ name	string	非必须		商品名
├─ cover_pic	string	非必须		商品图
├─ num	string	非必须		数量
├─ attr	string	非必须		规格
├─ goods_id	integer	必须
├─ goods_attr_id	integer	必须
├─ goods_info	string []	必须			item 类型: string
├─		非必须
├─ order_no	string	非必须		订单号
├─ is_big_gift	number	非必须		是否是大礼包1是0否
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

我送出的

基本信息

Path： /plugin/gift/api/order-list/send-list

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ num	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_confirm	string	必须
├─ type	string	必须
├─ open_time	string	必须
├─ open_num	string	必须
├─ open_type	string	必须
├─ bless_word	string	必须
├─ auto_refund_time	string	必须
├─ userOrder	object []	必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ gift_id	string	必须
├─ is_turn	string	必须
├─ turn_no	string	必须
├─ turn_user_id	string	必须
├─ is_receive	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_win	string	必须
├─ token	string	必须
├─ user	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须
├─ user	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须
├─ sendOrder	object []	必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ user_id	string	必须
├─ gift_id	string	必须
├─ order_no	string	必须
├─ total_price	string	必须
├─ total_pay_price	string	必须
├─ is_pay	string	必须
├─ pay_type	string	必须
├─ pay_time	string	必须
├─ is_refund	string	必须
├─ is_confirm	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ support_pay_types	string	必须
├─ token	string	必须
├─ detail	object []	必须			item 类型: object
├─ id	string	必须
├─ send_order_id	string	必须
├─ goods_id	string	必须
├─ goods_attr_id	string	必须
├─ goods_info	string	必须
├─ num	string	必须
├─ unit_price	string	必须
├─ total_original_price	string	必须
├─ total_price	string	必须
├─ is_refund	string	必须
├─ refund_status	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ receive_num	string	必须
├─ refund_price	string	必须
├─ goods	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	string,null	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ status	string	必须
├─ is_big_gift	number	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

我送出的详情

基本信息

Path： /plugin/gift/api/order-list/send-detail

Method： GET

接口描述：

convert_list     已领取
wait_list           等待
refund_list       已退款
success_list     成功

请求参数

Query

参数名称	是否必须	示例	备注
gift_id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ num	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_confirm	string	非必须
├─ type	string	非必须
├─ open_time	string	非必须
├─ open_num	string	非必须
├─ open_type	string	非必须
├─ bless_word	string	非必须
├─ auto_refund_time	string	非必须
├─ status	string	非必须
├─ status_num	number	非必须
├─ convert_list	object	非必须
├─ list	string []	非必须			item 类型: string
├─		非必须
├─ total_price	number	非必须
├─ wait_list	object	非必须
├─ list	object []	非必须			item 类型: object
├─ name	string	非必须
├─ cover_pic	string	非必须
├─ goods_info	string	非必须
├─ num	string	非必须
├─ total_price	string	非必须
├─ total_price	number	非必须
├─ order_no	string	非必须
├─ pay_time	string	非必须

插件相关设置

基本信息

Path： /plugin/gift/api/gift-index/config

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ title	string	非必须		标题
├─ type	string []	非必须		送礼方式direct_open直接送time_open定时开奖num_open满人开奖	item 类型: string
├─		非必须
├─ bless_word	string	非必须		祝福语
├─ ask_gift	string	非必须		求礼物语
├─ explain	string	非必须		规则
├─ background	object	非必须		背景图
├─ bg_pic	string	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ color	string	非必须
├─ theme	object	非必须		主题
├─ id	string	非必须
├─ active	string	非必须
├─ text	string	非必须
├─ pic_url	string	非必须

填写地址提交

基本信息

Path： /plugin/gift/api/gift-order/gift-convert

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
form_data	是	{"list":[{"mch_id":0,"goods_list":[],"use_integral":0,"user_coupon_id":0,"distance":0,"remark":"","order_form":[]}],"address_id":0}

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
data	object	必须
├─ token	string	必须
├─ queue_id	string	必须

礼物下单

基本信息

Path： /plugin/gift/api/gift-order/order-submit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
id	否		礼物订单重新付款的时候传入
type	是
open_time	是
open_num	是
open_type	是
bless_word	是
form_data	是
bless_music	是		语音

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ token	string	非必须
├─ queue_id	string	非必须

礼物记录

基本信息

Path： /plugin/gift/mall/record/tribute

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
keyword	否	name/order_no/nickname/user_id
keyword_1	否
platform	否		平台标识
type	否		礼物类型 直接送 direct_open 定时送 time_open 满人送 num_open
page	否		页码
start_date	否		开始时间
end_date	否		结束时间

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ num	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_confirm	string	必须
├─ type	string	必须
├─ open_time	string	必须
├─ open_num	string	必须
├─ open_type	string	必须
├─ bless_word	string	必须
├─ auto_refund_time	string	必须
├─ userOrder	object []	必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ gift_id	string	必须
├─ is_turn	string	必须
├─ turn_no	string	必须
├─ turn_user_id	string	必须
├─ is_receive	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_win	string	必须
├─ token	string	必须
├─ user	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须
├─ giftOrderNum	object []	必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ order_no	string	必须
├─ goods_id	string	必须
├─ goods_attr_id	string	必须
├─ num	string	必须
├─ order_id	string	必须
├─ type	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ user_order_id	string	必须
├─ is_refund	string	必须
├─ user	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须
├─ sendOrder	object []	必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ user_id	string	必须
├─ gift_id	string	必须
├─ order_no	string	必须
├─ total_price	string	必须
├─ total_pay_price	string	必须
├─ is_pay	string	必须
├─ pay_type	string	必须
├─ pay_time	string	必须
├─ is_refund	string	必须
├─ is_confirm	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ support_pay_types	string	必须
├─ token	string	必须
├─ detail	object []	必须			item 类型: object
├─ id	string	必须
├─ send_order_id	string	必须
├─ goods_id	string	必须
├─ goods_attr_id	string	必须
├─ goods_info	string	必须
├─ num	string	必须
├─ unit_price	string	必须
├─ total_original_price	string	必须
├─ total_price	string	必须
├─ is_refund	string	必须
├─ refund_status	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ receive_num	string	必须
├─ refund_price	string	必须
├─ goods	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	null,string	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ status	string	必须
├─ is_big_gift	number	必须		是否大礼包1是0否
├─ join_num	number	必须		参与数
├─ win_num	number	必须		领取数
├─ address_status	string	必须		填写地址状态
├─ total_pay_price	number	必须		支付金额
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

被转赠

基本信息

Path： /plugin/gift/api/gift-order/get-turn

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
turn_no	是		转赠码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	object	非必须

转赠

基本信息

Path： /plugin/gift/api/gift-order/turn

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ turn_no	string	非必须		转赠码

送礼取消支付

基本信息

Path： /plugin/gift/api/gift-order/order-cancel

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
gift_id	是		礼物ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

领取记录

基本信息

Path： /plugin/gift/mall/record/receive

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
keyword	否	name/nickname/user_id/gift_order_id
keyword_1	否
start_date	否		开始时间
end_date	否		结束时间
page	否	1
gift_id	否	233

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ gift_id	string	非必须
├─ is_turn	string	非必须
├─ turn_no	string	非必须
├─ turn_user_id	string	非必须
├─ is_receive	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_win	string	非必须
├─ token	string	非必须
├─ user	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须
├─ giftLog	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ num	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_confirm	string	非必须
├─ type	string	非必须
├─ open_time	string	非必须
├─ open_num	string	非必须
├─ open_type	string	非必须
├─ bless_word	string	非必须
├─ auto_refund_time	string	非必须
├─ user	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须
├─ sendOrder	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ user_id	string	非必须
├─ gift_id	string	非必须
├─ order_no	string	非必须
├─ total_price	string	非必须
├─ total_pay_price	string	非必须
├─ is_pay	string	非必须
├─ pay_type	string	非必须
├─ pay_time	string	非必须
├─ is_refund	string	非必须
├─ is_confirm	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ support_pay_types	string	非必须
├─ token	string	非必须
├─ detail	object []	非必须			item 类型: object
├─ id	string	非必须
├─ send_order_id	string	非必须
├─ goods_id	string	非必须
├─ goods_attr_id	string	非必须
├─ goods_info	string	非必须
├─ num	string	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ is_refund	string	非必须
├─ refund_status	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ receive_num	string	非必须
├─ refund_price	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	null	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ giftOrder	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ order_no	string	非必须
├─ goods_id	string	非必须
├─ goods_attr_id	string	非必须
├─ num	string	非必须
├─ order_id	string	非必须
├─ type	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ user_order_id	string	非必须
├─ is_refund	string	非必须
├─ order	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ mch_id	string	非必须
├─ order_no	string	非必须
├─ total_price	string	非必须
├─ total_pay_price	string	非必须
├─ express_original_price	string	非必须
├─ express_price	string	非必须
├─ total_goods_price	string	非必须
├─ total_goods_original_price	string	非必须
├─ member_discount_price	string	非必须
├─ use_user_coupon_id	string	非必须
├─ coupon_discount_price	string	非必须
├─ use_integral_num	string	非必须
├─ integral_deduction_price	string	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ address	string	非必须
├─ remark	string	非必须
├─ order_form	string	非必须
├─ words	string	非必须
├─ seller_remark	string	非必须
├─ is_pay	string	非必须
├─ pay_type	string	非必须
├─ pay_time	string	非必须
├─ is_send	string	非必须
├─ send_time	string	非必须
├─ customer_name	string	非必须
├─ express	string	非必须
├─ express_no	string	非必须
├─ is_sale	string	非必须
├─ is_confirm	string	非必须
├─ confirm_time	string	非必须
├─ cancel_status	string	非必须
├─ cancel_time	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_recycle	string	非必须
├─ send_type	string	非必须
├─ offline_qrcode	string	非必须
├─ clerk_id	string	非必须
├─ store_id	string	非必须
├─ sign	string	非必须
├─ token	string	非必须
├─ support_pay_types	string	非必须
├─ is_comment	string	非必须
├─ comment_time	string	非必须
├─ sale_status	string	非必须
├─ status	string	非必须
├─ back_price	string	非必须
├─ auto_cancel_time	string	非必须
├─ auto_confirm_time	null	非必须
├─ auto_sales_time	null	非必须
├─ distance	string	非必须
├─ city_mobile	string	非必须
├─ location	null	非必须
├─ city_name	null	非必须
├─ city_info	null	非必须
├─ store	null	非必须
├─ detail	object []	非必须			item 类型: object
├─ id	string	非必须
├─ order_id	string	非必须
├─ goods_id	string	非必须
├─ num	string	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ member_discount_price	string	非必须
├─ goods_info	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_refund	string	非必须
├─ refund_status	string	非必须
├─ back_price	string	非必须
├─ sign	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	null	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	null	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ goodsAttr	object	非必须
├─ id	string	非必须
├─ goods_id	string	非必须
├─ sign_id	string	非必须
├─ stock	string	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	string	非必须
├─ pic_url	string	非必须
├─ is_delete	string	非必须
├─ parent	null	非必须
├─ address_status	string	非必须
├─ turn_list	object	非必须
├─ gift_user	object	非必须
├─ nickname	string	非必须
├─ avatar	string	非必须
├─ platform	string	非必须
├─ turn_num	number	非必须
├─ parent_user	null	非必须
├─ self_user	object	非必须
├─ nickname	string	非必须
├─ avatar	string	非必须
├─ platform	string	非必须
├─ detail	object []	非必须			item 类型: object
├─ detail_id	string	非必须
├─ name	string	非必须
├─ cover_pic	string	非必须
├─ num	string	非必须
├─ attr	string	非必须
├─ goods_id	integer	必须
├─ goods_attr_id	integer	必须
├─ goods_info	string []	必须			item 类型: string
├─		非必须
├─ order_no	string	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

领取详情

基本信息

Path： /plugin/gift/api/gift-index/gift

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
gift_id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ num	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_confirm	string	非必须
├─ type	string	非必须
├─ open_time	string	非必须		开奖时间
├─ open_num	string	非必须		开奖人数
├─ open_type	string	非必须		1一个得奖0多人随机得奖品
├─ bless_word	string	非必须		祝福语
├─ auto_refund_time	string	非必须
├─ userOrder	string []	非必须			item 类型: string
├─		非必须
├─ winUser	string []	非必须		中奖用户	item 类型: string
├─		非必须
├─ user	object	非必须		送礼人
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ total_balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ platform	string	非必须
├─ temp_parent_id	string	非必须
├─ sendOrder	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ user_id	string	非必须
├─ gift_id	string	非必须
├─ order_no	string	非必须
├─ total_price	string	非必须
├─ total_pay_price	string	非必须
├─ is_pay	string	非必须
├─ pay_type	string	非必须
├─ pay_time	string	非必须
├─ is_refund	string	非必须
├─ is_confirm	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ support_pay_types	string	非必须
├─ token	string	非必须
├─ detail	object []	非必须			item 类型: object
├─ id	string	非必须
├─ send_order_id	string	非必须
├─ goods_id	string	非必须
├─ goods_attr_id	string	非必须
├─ goods_info	string	非必须
├─ num	string	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ is_refund	string	非必须
├─ refund_status	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ receive_num	string	非必须
├─ refund_price	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	string	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ num	number	非必须		参与人数
├─ win_num	number	非必须		中奖人数
├─ win_time	string	非必须		被领光时间
├─ win_goods_name	string	非必须		礼物领取情况文字
├─ win_goods_status	number	非必须		礼物领取状态
├─ refund_time	number	非必须		退款剩余时间
├─ is_gift_null	number	非必须		是否被领光
├─ status	number	非必须		当前用户中奖状态1中0否
├─ address_status	number	非必须		当前用户地址是否填写1是0否
├─ join_status	number	非必须		当前用户参与状态1是0否
├─ open_status	number	非必须		开奖状态1开0否
├─ is_big_gift	number	非必须		是否大礼包1是0否
├─ setting	number	非必须

下单

订单信息预览

基本信息

Path： /api/order/preview

Method： GET

接口描述：

shuominhg

请求参数

Query

参数名称	是否必须	示例	备注
form_data	是	{"list":[{"mch_id":0,"goods_list":[{"id":39185,"attr":[{"attr_id":2,"attr_group_id":1},{"attr_id":4,"attr_group_id":2}],"num":1,"cat_id":0,"goods_attr_id":76798,"cart_id":0}],"distance":0,"remark":"","order_form":[],"use_integral":0,"user_coupon_id":0}],"address_id":0}

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ mch_list	object []	非必须		商户列表	item 类型: object
├─ mch	object	非必须		商户信息
├─ id	number	非必须		商户id，主商城为0
├─ name	string	非必须		商户名称
├─ goods_list	object []	非必须		商品列表	item 类型: object
├─ id	number	非必须		商品id
├─ name	string	非必须		商品名
├─ num	number	非必须		购买数量
├─ accumulative	number	非必须
├─ unit_price	string	非必须		商品单价
├─ total_original_price	string	非必须		商品小记总价，优惠前
├─ total_price	string	非必须		商品小记总价，优惠后
├─ attr_list	object []	非必须		商品规格信息	item 类型: object
├─ attr_group_name	string	非必须		规格组名称
├─ attr_group_id	number	非必须		规格组id
├─ attr_id	number	非必须		规格id
├─ attr_name	string	非必须		规格值
├─ discounts	string []	非必须			item 类型: string
├─		非必须
├─ cover_pic	string	非必须		商品图片
├─ is_level_alone	number	非必须
├─ custom_currency	string []	非必须			item 类型: string
├─		非必须
├─ goods_warehouse_id	number	非必须		商品库的商品id
├─ sign	string	非必须
├─ form_data	object	非必须		表单提交form_data信息中对应商户的信息
├─ mch_id	number	非必须
├─ goods_list	object []	非必须			item 类型: object
├─ id	number	非必须
├─ attr	object []	非必须			item 类型: object
├─ attr_id	number	必须
├─ attr_group_id	number	必须
├─ num	number	非必须
├─ cat_id	number	非必须
├─ goods_attr_id	number	非必须
├─ cart_id	number	非必须
├─ distance	number	非必须
├─ remark	string	非必须
├─ order_form	string []	非必须			item 类型: string
├─		非必须
├─ use_integral	number	非必须
├─ user_coupon_id	number	非必须
├─ express_price	string	非必须		运费
├─ remark	string	非必须		订单备注
├─ order_form_data	object []	非必须		已填写的自定义表单	item 类型: object
├─ key	string	非必须		表单类型
├─ label	string	非必须		表单名称
├─ required	number	非必须		是否必填：0=非必填，1=必填
├─ value	string	非必须		用户填写的值
├─ total_goods_price	string	非必须		商品小记总价（优惠后）
├─ total_goods_original_price	string	非必须		商品小记总价（优惠前）
├─ member_discount	string	非必须
├─ coupon	object	非必须		优惠券信息
├─ enabled	boolean	非必须		是否可以使用优惠券
├─ use	boolean	非必须		是否已使用优惠券
├─ coupon_discount	string	非必须
├─ user_coupon_id	number	非必须		使用的优惠券id
├─ coupon_error	null	非必须		优惠券错误信息
├─ integral	object	非必须		积分抵扣信息
├─ can_use	boolean	非必须		是否可以使用积分抵扣
├─ use	boolean	非必须		是否已使用积分抵扣
├─ use_num	number	非必须		使用积分数量
├─ deduction_price	string	非必须		积分抵扣的金额
├─ delivery	object	非必须		配送方式
├─ send_type	string	非必须		配送方式：express=快递，offline=自提，city=同城
├─ disabled	boolean	非必须
├─ send_type_list	object []	非必须		可选配送方式列表	item 类型: object
├─ name	string	必须		配送方式显示名称
├─ value	string	必须		配送方式
├─ store	object	非必须		所选门店信息
├─ id	number	非必须		门店id
├─ mall_id	string	非必须		所属商城id
├─ mch_id	string	非必须		所属商户id
├─ name	string	非必须		门店名称
├─ mobile	string	非必须		门店电话
├─ address	string	非必须		门店地址
├─ longitude	string	非必须		门店经度
├─ latitude	string	非必须		门店纬度
├─ distance	string	非必须		门店距离（eg. 100m | 65.54km）
├─ store_select_enable	boolean	非必须		是否可以选择门店
├─ total_price	string	非必须		商户总价小记（优惠后）
├─ order_form	object	非必须		下单自定义表单信息
├─ name	string	非必须		表单标题
├─ status	string	非必须		状态：0=未启用，1=启用，（请使用非全等判断）
├─ value	object []	非必须		表单详细内容	item 类型: object
├─ key	string	非必须		表单类型（text、radio、checkbox、date...）
├─ key_name	string	非必须		表单类型（中文）
├─ name	string	非必须		表单名称
├─ is_required	number	非必须		是否必填：0=非必填，1=必填（请使用非全等判断）
├─ hint	string	非必须		表单提示文字
├─ total_price	string	非必须		订单总金额（含运费）
├─ price_enable	boolean	非必须		金额是否满足下单要求
├─ address	object	非必须		收获地址信息
├─ id	number	非必须		收货地址ID
├─ user_id	number	非必须
├─ name	string	非必须		收货人姓名
├─ province_id	number	非必须		省份id
├─ province	string	非必须		省份名称
├─ city_id	number	非必须		城市id
├─ city	string	非必须		城市名称
├─ district_id	number	非必须		县/区id
├─ district	string	非必须		县/区名称
├─ mobile	string	非必须		收货人手机
├─ detail	string	非必须		详细收获地址
├─ is_default	number	非必须		是否是默认地址：0=否，1=是
├─ latitude	string	非必须		收货地址纬度
├─ longitude	string	非必须		收货地址经度
├─ location	string	非必须
├─ address_enable	boolean	非必须		所选收货地址是否可以发货
├─ has_ziti	boolean	非必须		所有订单中是否含有自体订单
├─ custom_currency_all	string []	非必须			item 类型: string
├─		非必须
├─ allZiti	boolean	非必须		是否所有订单都是自提订单
├─ hasCity	boolean	非必须

diy接口

搜索框组件

基本信息

Path： /search

Method： GET

接口描述：

补充diy页面接口的组件数据中id=search的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
color	string	必须		搜索框背景色
background	string	必须		组件背景色
radius	integer	必须		搜索框圆角
placeholder	string	必须		搜索框提示文字
textColor	string	必须		搜索框文字颜色
textPosition	string	必须		搜索框文字位置

专题

基本信息

Path： /topic

Method： GET

接口描述：

补充diy页面接口的组件数据中id=topic的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
style	string	必须		样式	枚举: normal,list 枚举备注: normal--简易模式 list--列表模式
count	integer	必须		显示数量仅在style=normal下有效
logo_1	string	必须		专题图标仅在count=1时有效
logo_2	string	必须		专题图标仅在count=2时有效
icon	string	必须		左侧图标仅在style=normal时有效
cat_show	boolean	必须		是否显示分类，仅在style=list时有效
topic_list	object []	必须		专题列表	item 类型: object
├─ id	integer	必须		专题id
├─ title	string	必须		专题名称
list	object []	必须		分类列表仅在style=list时有效	item 类型: object
├─ cat_id	integer	必须		分类id
├─ cat_name	string	必须		原名称
├─ name	string	必须		显示的名称
├─ children	object []	必须		专题列表	item 类型: object
├─ id	string	必须		专题id
├─ title	string	必须		专题名称
├─ cover_pic	string	必须		专题图片
├─ read_count	string	必须		浏览人数
├─ layout	integer	必须		样式	枚举: 1,2,0 枚举备注: 0--小图模式 1--大图模式 2--多图模式
├─ abstract	string	必须		摘要
├─ pic_list	object []	必须		图片列表仅在layout=2时有效	item 类型: object
├─ url	string	必须		图片地址
├─ custom	boolean	必须		是否自定义专题
├─ number	integer	必须		自定义专题数量（custom=true下有效）

倒计时

基本信息

Path： /timer

Method： GET

接口描述：

补充diy页面接口的组件数据中id=timer的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
picUrl	string	必须		图片地址
link	object	必须		具体参考公共信息link
startDateTime	string	必须		开始时间
endDateTime	string	必须		结束时间

公共信息

基本信息

Path： /diy

Method： GET

接口描述：

组件数据中，公共部分

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
params	object []	必须		链接参数	item 类型: object
├─ key	string	必须		参数key
├─ value	string	必须		参数值
link	object	必须		链接
├─ name	string	必须		链接名称
├─ open_type	string	必须		链接类型
├─ value	string	必须		链接路由
├─ new_link_url	string	必须		链接拼接路由
├─ params	object []	必须		链接参数	item 类型: object
├─ key	string	必须		参数key
├─ value	string	必须		参数值

公告

基本信息

Path： /notice

Method： GET

接口描述：

补充diy页面接口的组件数据中id=notice的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
name	string	必须		名称
content	string	必须		内容
icon	string	必须		图标地址
textColor	string	必须		文字颜色
background	string	必须		背景色
headerUrl	string	必须		弹窗头部图片地址
btnColor	string	必须		弹窗按钮背景色
btnWidth	number	必须		弹窗按钮宽度
btnHeight	number	必须		弹窗按钮高度
btnRadius	number	必须		弹窗按钮圆角
btnText	string	必须		弹窗按钮文本
btnTextColor	string	必须		弹窗按钮文本颜色

关联链接

基本信息

Path： /link

Method： GET

接口描述：

补充diy页面接口的组件数据中id=link的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
title	string	必须		标题
textLeft	number	必须		标题左边距
link	object	必须		具体见公共信息link
picSwitch	boolean	必须		图片开关
arrowsSwitch	boolean	必须		箭头开关
picUrl	string	必须		图片地址
picLeft	number	必须		图片左边距
color	string	必须		标题颜色
background	string	必须		背景色

商品

基本信息

Path： /goods

Method： GET

接口描述：

补充diy页面接口的组件数据中id=goods的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
showCat	boolean	必须		是否展示分类
catPosition	string	必须		分类位置（showCat=true时有效）	枚举: left,top 枚举备注: left--左侧位置 top--顶部位置
catStyle	integer	必须		分类样式（catPosition=top时有效）	枚举: 1,2 枚举备注: 1--页签形式 2--填充形式
catList	object []	必须		分类列表	item 类型: object
├─ id	integer	必须		分类id
├─ name	string	必须		原始名称
├─ menuName	string	必须		显示名称
├─ staticGoods	boolean	必须		是否开启自定义商品
├─ goodsNum	integer	必须		商品数量（staticGoods=false时有效）
├─ goodsList	string []	必须		同下list	item 类型: string
├─		非必须
list	object []	必须		商品列表	item 类型: object
├─ id	integer	必须		商品id
├─ mch_id	integer	必须		商品所属商户id
├─ sign	string	必须		商品所属插件
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		缩略图
├─ original_price	number	必须		原价
├─ unit	string	必须		单位
├─ page_url	string	必须		商品详情路径
├─ is_negotiable	integer	必须		是否价格面议	枚举: 1,0 枚举备注: 1--价格面议 0--否
├─ is_level	integer	必须		是否享受会员价	枚举: 1,0 枚举备注: 1--享受会员价 0--否
├─ level_price	number	必须		会员价
├─ price	number	必须		售价
├─ price_content	string	必须		商品售价文本
├─ is_sales	integer	必须		是否显示销量	枚举: 1,0 枚举备注: 1--显示销量 0--不显示
├─ sales	string	必须		销量文本
├─ vip_card_appoint	object	必须
├─ discount	string	必须		折扣
├─ is_my_vip_card_goods	integer	必须		登录用户是否享受商品折扣	枚举: 1,0 枚举备注: 1--是 0--否
├─ is_vip_card_user	integer	必须		登录用户是不是会员	枚举: 1,0 枚举备注: 1--是 0--否
listStyle	integer	必须		商品列表样式	枚举: -1,0,1,2,3 枚举备注: -1--列表模式 0--左右滑动 1--一行一个 2--一行两个 3--一行三个
goodsCoverProportion	string	必须		封面图宽高比例	枚举: 1-1,3-2 枚举备注: '1-1'--宽高比1：1 '3-2'--宽高比3：2
fill	integer	必须		封面图填充方式	枚举: 1,0 枚举备注: 1--填充 2--留白
goodsStyle	integer	必须		单品样式	枚举: 1,2,3,4 枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中
showGoodsName	boolean	必须		是否显示商品名称
showGoodsPrice	boolean	必须		是否显示商品价格（售价和原价）
showBuyBtn	boolean	必须		是否显示购买按钮
buyBtn	string	必须		购买按钮样式	枚举: cart,add,text 枚举备注: cart--购物车 add--加号 text--文字样式
buyBtnStyle	integer	必须		按钮样式仅在buyBtn=text时	枚举: 1,2,3,4 枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条
buyBtnText	string	必须		按钮文本仅在buyBtn=text时有效
showGoodsTag	boolean	必须		是否展示商品角标
customizeGoodsTag	boolean	必须		是否自定义角标
goodsTagPicUrl	string	必须		商品角标地址

图文详情

基本信息

Path： /image-text

Method： GET

接口描述：

补充diy页面接口的组件数据中id=image-text的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
content	string	必须		图文详情内容

图片广告

基本信息

Path： /rubik

Method： GET

接口描述：

补充diy页面接口的组件数据中id=rubik的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
style	integer	必须		样式	枚举: 1,0,2,3,4,5,6,7,8 枚举备注: 0--一张图 1--两张图 2--三张图 3--四张图 4--两张图左右平分 5--三张图左右平分 6--四张图左右平分 7--四张图上下左右平分 8--自定义魔方
space	integer	必须		图片间隙
height	integer	必须		组件高度
list	object []	必须		图片列表	item 类型: object
├─ width	string	必须		图片宽度
├─ height	string	必须		图片高度
├─ left	string	必须		图片左边距
├─ top	string	必须		图片上边距
├─ pic_url	string	必须		图片地址
├─ link	object	必须		具体见公共信息link
hotspot	object []	必须		热区列表	item 类型: object
├─ height	string	必须		热区高度
├─ width	string	必须		热区宽度
├─ left	string	必须		热区左边距
├─ top	string	必须		热区上边距
├─ link	object	必须		具体见公共信息link

地图

基本信息

Path： /map

Method： GET

接口描述：

补充diy页面接口的组件数据中id=map的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
location	string	必须		定位地址（纬度，经度）
height	integer	必须		地图高度
paddingY	integer	必须		组件上下内边距
paddingX	integer	必须		组件左右内边距
marginTop	integer	必须		组件顶部外边距
marginTopColor	string	必须		组件顶部外边距背景色
backgroundColor	string	必须		组件背景色
backgroundPicUrl	string	必须		组件背景图片
latitude	string	必须		纬度
longitude	string	必须		经度

好店推荐

基本信息

Path： /mch

Method： GET

接口描述：

补充diy页面接口的组件数据中id=mch的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
showGoods	boolean	必须		是否显示商品
list	object []	必须		店铺列表	item 类型: object
├─ id	string	必须		店铺id
├─ name	string	必须		店铺名称
├─ picUrl	string	必须		展示图
├─ goodsNum	string	必须		商品数量
├─ orderNum	string	必须		订单数量
├─ goodsList	object []	必须		商品列表	item 类型: object
├─ id	string	必须		商品id
├─ name	string	必须		商品名称
├─ picUrl	string	必须		商品图片
├─ price	string	必须		商品售价
├─ showGoodsNum	integer	必须		显示商品数量
├─ staticGoods	boolean	必须		是否自定义商品
├─ pic_url	string	必须		展示图
├─ goods_num	string	必须		商品数量
├─ longitude	string	必须		经度
├─ latitude	string	必须		纬度

导航图标

基本信息

Path： /nav

Method： GET

接口描述：

补充diy页面接口的组件数据中id=nav的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
background	string	必须		背景色
color	string	必须		文字颜色
rows	integer	必须		每页显示行数
columns	integer	必须		每行显示个数
scroll	boolean	必须		是否左右滑动
navs	object []	必须		导航图标列表	item 类型: object
├─ icon	string	必须		图标地址
├─ name	string	必须		名称
├─ openType	string	必须		链接类型
├─ url	string	必须		链接路由
├─ icon_url	string	必须		图标地址
├─ link_url	string	必须		链接路由
├─ open_type	string	必须		链接类型

幸运抽奖

基本信息

Path： /lottery

Method： GET

接口描述：

补充diy页面接口的组件数据中id=lottery的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
buttonColor	string	必须		购买文字按钮颜色
list	object []	必须		商品列表	item 类型: object
├─ id	integer	必须		商品id
├─ goods_warehouse_id	integer	必须		商品库id
├─ mch_id	integer	必须		商品所属商户id
├─ sign	string	必须		商品所属插件标示
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		缩略图
├─ original_price	number	必须		原价
├─ unit	string	必须		单位
├─ page_url	string	必须		商品详情路径
├─ is_level	integer	必须		是否享受会员价	枚举: 1,0 枚举备注: 1--享受 0--否
├─ level_price	number	必须		会员价
├─ price	number	必须		售价
├─ price_content	string	必须		价格显示文本
├─ vip_card_appoint	object	必须		超级会员卡
├─ discount	string	必须		折扣
├─ is_my_vip_card_goods	integer	必须		登录用户是否享受商品折扣
├─ is_vip_card_user	integer	必须		登录用户是不是会员
├─ start_time	string	必须		开始时间
├─ end_time	string	必须		结束时间
listStyle	integer	必须		列表样式	枚举: -1,1 枚举备注: -1--列表模式 1--一行一个 2--一行两个
fill	integer	必须		封面图填充方式	枚举: 1,0 枚举备注: 1--填充 0--留白
goodsCoverProportion	string	必须		封面图宽高比例仅在listStyle=1是有效	枚举: 1-1,3-2 枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2
goodsStyle	integer	必须		单品样式	枚举: 1,2,3 枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中
showGoodsName	boolean	必须		是否显示商品名称
showBuyBtn	boolean	必须		是否显示购买按钮
buyBtnStyle	integer	必须		购买按钮样式	枚举: 1,2,3 枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条
buyBtnText	string	必须		购买按钮文本
showGoodsTag	boolean	必须		是否显示角标
customizeGoodsTag	boolean	必须		是否自定义角标
goodsTagPicUrl	string	必须		角标图片地址

弹窗广告

基本信息

Path： /modal

Method： GET

接口描述：

补充diy页面接口的组件数据中id=modal的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
opened	boolean	必须		是否开启弹窗广告
list	array []	必须		列表	item 类型: array
├─		非必须
├─ picUrl	string	必须		图片
├─ link	object	必须		具体参考公共信息link
times	integer	必须		弹窗次数	枚举: 1,0 枚举备注: 1--仅首次 0--每次

微信公众号

基本信息

Path： /mp-link

Method： GET

接口描述：

补充diy页面接口的组件数据中id=mp-link的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
position	string	必须		组件位置	枚举: auto,top 枚举备注: auto--默认位置 top--固定悬浮在顶部

快捷导航

基本信息

Path： /quick-nav

Method： GET

接口描述：

补充diy页面接口的组件数据中id=quick-nav的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
closedPicUrl	string	必须		关闭导航图片 仅在navStyle=1时有效
openedPicUrl	string	必须		点击展开导航的图片 仅在navStyle=1时有效
navStyle	integer	必须		导航样式	枚举: 1 枚举备注: 1--样式一（点击收起） 2--样式二（全部展示）
navSwitch	integer	必须		组件开关	枚举: 1,0 枚举备注: 1--开启 0--关闭
useMallConfig	boolean	必须		是否使用商城配置
customerService	object	必须		小程序自带的客户
├─ picUrl	string	必须		图片地址
├─ opened	integer	必须		是否开启	枚举: 1 枚举备注: 1--开启 0--关闭
home	object	必须		返回首页
├─ opened	integer	必须		是否开启
├─ picUrl	string	必须		图片地址
mApp	object	必须		跳转小程序
├─ opened	integer	必须		是否开启
├─ small_app_id	string	必须		小程序appid
├─ small_app_url	string	必须		小程序路径
├─ small_app_pic	string	必须		图片地址
mapNav	object	必须
├─ opened	integer	必须		是否开启
├─ picUrl	string	必须		图片地址
├─ address	string	必须		详细地址
├─ latitude	string	必须		纬度
├─ longitude	string	必须		经度
tel	object	必须		一键拨号
├─ opened	integer	必须		是否开启
├─ picUrl	string	必须		图片地址
├─ number	string	必须		电话号码
web	object	必须		跳转外链
├─ opened	string	必须		是否开启
├─ picUrl	string	必须		图片地址
├─ url	string	必须		外链地址

拼团

基本信息

Path： /pintuan

Method： GET

接口描述：

补充diy页面接口的组件数据中id=pintuan的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
buttonColor	string	必须		购买文字按钮颜色
list	object []	必须		商品列表	item 类型: object
├─ id	integer	必须		商品id
├─ goods_warehouse_id	integer	必须		商品库id
├─ mch_id	integer	必须		商品所属商户id
├─ sign	string	必须		商品所属插件标示
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		缩略图
├─ original_price	number	必须		原价
├─ unit	string	必须		单位
├─ page_url	string	必须		商品详情路径
├─ is_level	integer	必须		是否享受会员价	枚举: 1,0 枚举备注: 1--享受 0--否
├─ level_price	number	必须		会员价
├─ price	number	必须		售价
├─ price_content	string	必须		价格显示文本
├─ vip_card_appoint	object	必须		超级会员卡
├─ discount	string	必须		折扣
├─ is_my_vip_card_goods	integer	必须		登录用户是否享受商品折扣
├─ is_vip_card_user	integer	必须		登录用户是不是会员
├─ people_num	string	必须		拼团人数
├─ pintuan_price	string	必须		拼团价格
listStyle	integer	必须		列表样式	枚举: -1,1 枚举备注: -1--列表模式 1--一行一个 2--一行两个
fill	integer	必须		封面图填充方式	枚举: 1,0 枚举备注: 1--填充 0--留白
goodsCoverProportion	string	必须		封面图宽高比例仅在listStyle=1是有效	枚举: 1-1,3-2 枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2
goodsStyle	integer	必须		单品样式	枚举: 1,2,3 枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中
showGoodsName	boolean	必须		是否显示商品名称
showBuyBtn	boolean	必须		是否显示购买按钮
buyBtnStyle	integer	必须		购买按钮样式	枚举: 1,2,3 枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条
buyBtnText	string	必须		购买按钮文本
showGoodsTag	boolean	必须		是否显示角标
customizeGoodsTag	boolean	必须		是否自定义角标
goodsTagPicUrl	string	必须		角标图片地址

优惠券

基本信息

Path： /coupon

Method： GET

接口描述：

补充diy页面接口的组件数据中id=coupon的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
textColor	string	必须		文字颜色
receiveBg	string	必须		已领取背景图
unclaimedBg	string	必须		未领取背景图
coupon_list	object []	必须		优惠券列表	item 类型: object
├─ id	integer	必须		优惠券id
├─ name	string	必须		优惠券名称
├─ type	integer	必须		优惠券类型	枚举: 1,2 枚举备注: 1--折扣券 2--满减券
├─ discount	number	必须		折扣率仅在type=1时有效
├─ discount_limit	number	必须		最大优惠金额仅在type=1时有效
├─ min_price	number	必须		最低消费金额仅在type=2是有效
├─ sub_price	number	必须		减免金额仅在type=2时有效
├─ total_count	integer	必须		剩余可领取数量（-1表示没限制）
├─ sort	integer	必须		排序按升序
├─ expire_type	integer	必须		有效期类型	枚举: 1 枚举备注: 1--*领取后N天内有效 2--一段时间内有效
├─ expire_day	integer	必须		有效天数仅在expire_type=1时有效
├─ begin_time	string	必须		有效期开始时间仅在expire_type=2时有效
├─ end_time	string	必须		有效期结束时间仅在expire_type=2时有效
├─ appoint_type	integer	必须		优惠范围	枚举: 1,2,3 枚举备注: 1--指定分类 2--指定商品 3--全场通用 4--仅用于当面付
├─ rule	string	必须		优惠券说明
├─ is_member	string	必须		领取方式：是否会员专享	枚举: 1,0 枚举备注: 1--是 0--否
├─ is_receive	integer	必须		用户领取数量

流量主

基本信息

Path： /ad

Method： GET

接口描述：

补充diy页面接口的组件数据中id=ad的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
id	string	必须		流量主id（微信）

版权

基本信息

Path： /copyright

Method： GET

接口描述：

补充diy页面接口的组件数据中id=copyright的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
picUrl	string	必须		图片地址
text	string	必须		版权文本
link	object	必须		具体参考公共信息link
backgroundColor	string	必须		背景色

用户信息

基本信息

Path： /user-info

Method： GET

接口描述：

补充diy页面接口的组件数据中id=user-info的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
style	integer	必须		样式	枚举: 1,2,3 枚举备注: 1--头像靠左 2--头像居中 3--头像内嵌
backgroundPicUrl	string	必须		背景图
backgroundColor	string	必须		背景色仅在style=3时有效

砍价

基本信息

Path： /bargain

Method： GET

接口描述：

补充diy页面接口的组件数据中id=bargain的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
buttonColor	string	必须		购买文字按钮颜色
list	object []	必须		商品列表	item 类型: object
├─ id	integer	必须		商品id
├─ goods_warehouse_id	integer	必须		商品库id
├─ mch_id	integer	必须		商品所属商户id
├─ sign	string	必须		商品所属插件标示
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		缩略图
├─ original_price	number	必须		原价
├─ unit	string	必须		单位
├─ page_url	string	必须		商品详情路径
├─ is_level	integer	必须		是否享受会员价	枚举: 1,0 枚举备注: 1--享受 0--否
├─ level_price	number	必须		会员价
├─ price	number	必须		售价
├─ price_content	string	必须		价格显示文本
├─ vip_card_appoint	object	必须		超级会员卡
├─ discount	string	必须		折扣
├─ is_my_vip_card_goods	integer	必须		登录用户是否享受商品折扣
├─ is_vip_card_user	integer	必须		登录用户是不是会员
├─ start_time	string	必须		开始时间
├─ end_time	string	必须		结束时间
listStyle	integer	必须		列表样式	枚举: -1,1 枚举备注: -1--列表模式 1--一行一个 2--一行两个
fill	integer	必须		封面图填充方式	枚举: 1,0 枚举备注: 1--填充 0--留白
goodsCoverProportion	string	必须		封面图宽高比例仅在listStyle=1是有效	枚举: 1-1,3-2 枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2
goodsStyle	integer	必须		单品样式	枚举: 1,2,3 枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中
showGoodsName	boolean	必须		是否显示商品名称
showBuyBtn	boolean	必须		是否显示购买按钮
buyBtnStyle	integer	必须		购买按钮样式	枚举: 1,2,3 枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条
buyBtnText	string	必须		购买按钮文本
showGoodsTag	boolean	必须		是否显示角标
customizeGoodsTag	boolean	必须		是否自定义角标
goodsTagPicUrl	string	必须		角标图片地址

秒杀

基本信息

Path： /miaosha

Method： GET

接口描述：

补充diy页面接口的组件数据中id=miaosha的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
buttonColor	string	必须		购买文字按钮颜色
list	object []	必须		商品列表	item 类型: object
├─ id	integer	必须		商品id
├─ goods_warehouse_id	integer	必须		商品库id
├─ mch_id	integer	必须		商品所属商户id
├─ sign	string	必须		商品所属插件标示
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		缩略图
├─ original_price	number	必须		原价
├─ unit	string	必须		单位
├─ page_url	string	必须		商品详情路径
├─ is_level	integer	必须		是否享受会员价	枚举: 1,0 枚举备注: 1--享受 0--否
├─ level_price	number	必须		会员价
├─ price	number	必须		售价
├─ price_content	string	必须		价格显示文本
├─ vip_card_appoint	object	必须		超级会员卡
├─ discount	string	必须		折扣
├─ is_my_vip_card_goods	integer	必须		登录用户是否享受商品折扣
├─ is_vip_card_user	integer	必须		登录用户是不是会员
├─ start_time	string	必须		开始时间
├─ end_time	string	必须		结束时间
listStyle	integer	必须		列表样式	枚举: -1,1 枚举备注: -1--列表模式 1--一行一个 2--一行两个
fill	integer	必须		封面图填充方式	枚举: 1,0 枚举备注: 1--填充 0--留白
goodsCoverProportion	string	必须		封面图宽高比例仅在listStyle=1是有效	枚举: 1-1,3-2 枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2
goodsStyle	integer	必须		单品样式	枚举: 1,2,3 枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中
showGoodsName	boolean	必须		是否显示商品名称
showBuyBtn	boolean	必须		是否显示购买按钮
buyBtnStyle	integer	必须		购买按钮样式	枚举: 1,2,3 枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条
buyBtnText	string	必须		购买按钮文本
showGoodsTag	boolean	必须		是否显示角标
customizeGoodsTag	boolean	必须		是否自定义角标
goodsTagPicUrl	string	必须		角标图片地址

积分商城

基本信息

Path： /integral-mall

Method： GET

接口描述：

补充diy页面接口的组件数据中id=integral-mall的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
buttonColor	string	必须		购买文字按钮颜色
showCoupon	boolean	必须		是否显示优惠券
couponPicUrl	string	必须		优惠券背景图
coupon_list	object []	必须		优惠券列表	item 类型: object
├─ id	integer	必须		优惠券id
├─ name	string	必须		优惠券名称
├─ type	integer	必须		优惠券类型	枚举: 1 枚举备注: 1--折扣券 2--满减券
├─ discount	string	必须		折扣率 仅在type=1时有效
├─ discount_limit	string	必须		最多抵扣 仅在type=1时有效
├─ min_price	number	必须		最低消费 仅在type=2时有效
├─ sub_price	number	必须		减免金额 仅在type=2时有效
├─ total_count	integer	必须		剩余数量（-1表示无限制）
├─ expire_type	integer	必须		有效期类型	枚举: 1 枚举备注: 1--领取后N天内有效 2--一段时间内有效
├─ expire_day	integer	必须		有效天数 仅在expire_type=1时有效
├─ begin_time	string	必须		有效期开始时间 仅在expire_type=2时有效
├─ end_time	string	必须		有效期结束时间 仅在expire_type=2时有效
├─ appoint_type	integer	必须		优惠范围	枚举: 1,2,3 枚举备注: 1--指定分类 2--指定商品 3--全场通用 4--仅用于当面付
├─ page_url	string	必须		优惠券详情路径
showGoods	boolean	必须		是否显示商品
list	object []	必须		商品列表	item 类型: object
├─ id	integer	必须		商品id
├─ goods_warehouse_id	integer	必须		商品库id
├─ mch_id	integer	必须		商品所属商户id
├─ sign	string	必须		商品所属插件标示
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		缩略图
├─ original_price	number	必须		原价
├─ unit	string	必须		单位
├─ page_url	string	必须		商品详情路径
├─ is_level	integer	必须		是否享受会员价	枚举: 1,0 枚举备注: 1--享受 0--否
├─ level_price	number	必须		会员价
├─ price	number	必须		售价
├─ price_content	string	必须		价格显示文本
├─ vip_card_appoint	object	必须		超级会员卡
├─ discount	string	必须		折扣
├─ is_my_vip_card_goods	integer	必须		登录用户是否享受商品折扣
├─ is_vip_card_user	integer	必须		登录用户是不是会员
listStyle	integer	必须		列表样式	枚举: -1,1 枚举备注: -1--列表模式 1--一行一个 2--一行两个
fill	integer	必须		封面图填充方式	枚举: 1,0 枚举备注: 1--填充 0--留白
goodsCoverProportion	string	必须		封面图宽高比例仅在listStyle=1是有效	枚举: 1-1,3-2 枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2
goodsStyle	integer	必须		单品样式	枚举: 1,2,3 枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中
showGoodsName	boolean	必须		是否显示商品名称
showBuyBtn	boolean	必须		是否显示购买按钮
buyBtnStyle	integer	必须		购买按钮样式	枚举: 1,2,3 枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条
buyBtnText	string	必须		购买按钮文本
showGoodsTag	boolean	必须		是否显示角标
customizeGoodsTag	boolean	必须		是否自定义角标
goodsTagPicUrl	string	必须		角标图片地址

空白快

基本信息

Path： /empty

Method： GET

接口描述：

补充diy页面接口的组件数据中id=empty的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
background	string	必须		背景色
height	integer	必须		高度

签到

基本信息

Path： /check-in

Method： GET

接口描述：

补充diy页面接口的组件数据中id=check-in的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
backgroundPicUrl	string	必须		背景图片
showText	boolean	必须		是否展示文本
textPosition	string	必须		文本位置	枚举: left,center,right 枚举备注: left--靠左 center--居中 right--靠右
textColor	string	必须		文本颜色
hotspot	object	必须		热区
├─ height	integer	必须		热区高度
├─ width	integer	必须		热区宽度
├─ left	integer	必须		热区左边距
├─ top	integer	必须		热区上边距
├─ is_close	boolean	必须		是否关闭
award	object	必须
├─ continue	integer	必须		连续签到天数
├─ number	number	必须		奖励数量
├─ type	string	必须		奖励类型	枚举: integral,balance 枚举备注: integral--积分 balance--余额

自定义表单

基本信息

Path： /form

Method： GET

接口描述：

补充diy页面接口的组件数据中id=form的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
style	integer	必须			枚举: 1,2,3 枚举备注: 1--样式一 2--样式二 3--样式三
height	integer	必须
inputPadding	integer	必须
marginBottom	integer	必须
radius	integer	必须
type	integer	必须
times	integer	必须

视频

基本信息

Path： /video

Method： GET

接口描述：

补充diy页面接口的组件数据中id=video的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
pic_url	string	必须		视频封面图
url	string	必须		视频地址

订单入口

基本信息

Path： /user-order

Method： GET

接口描述：

补充diy页面接口的组件数据中id=user-order的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
navs	object []	必须		图标列表	item 类型: object
├─ url	string	必须		链接路由
├─ openType	string	必须		链接类型
├─ picUrl	string	必须		图标地址
├─ text	string	必须		图标文本
├─ num	string	必须		显示数量
├─ open_type	string	必须		链接类型
├─ link_url	string	必须		链接路由
├─ name	string	必须		显示文本
├─ icon_url	string	必须		显示图标地址
backgroundColor	string	必须		组件背景色

超级会员卡

基本信息

Path： /vip-card

Method： GET

接口描述：

补充diy页面接口的组件数据中id=vip-card的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
buy_bg	string	非必须		未购买用户背景图
renew_bg	string	非必须		已购买用户背景图
buy_big_color	string	非必须		未购买用户大标题颜色
buy_small_color	string	非必须		未购买用户小标题颜色
buy_btn_color	string	非必须		未购买用户按钮颜色
buy_btn_bg_color	string	非必须		未购买用户按钮背景颜色
buy_big	string	非必须		未购买用户大标题
buy_small	string	非必须		未购买用户小标题
buy_btn_text	string	非必须		未购买用户按钮文字
renew_text_color	string	非必须		已购买用户文字颜色
renew_btn_bg_color	string	非必须		已购买用户按钮北京颜色
renew_text	string	非必须		已购买用户文字
usePluginConfig	boolean	非必须
background	string	非必须		背景色
top_bottom_padding	number	非必须

轮播图

基本信息

Path： /banner

Method： GET

接口描述：

补充diy页面接口的组件数据中id=banner的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
style	integer	必须		样式	枚举: 1,2 枚举备注: 1--普通样式 2--卡片样式
fill	integer	必须		填充方式	枚举: 1 枚举备注: 1--填充 0--留白
height	integer	必须		高度
banners	object []	必须		列表	item 类型: object
├─ picUrl	string	必须		图片地址
├─ openType	string	必须		链接类型
├─ url	string	必须		链接路由
├─ params	object []	必须		具体参考公共信息	item 类型: object
├─ page_url	string	必须		链接路由
├─ open_type	string	必须		链接类型
├─ pic_url	string	必须		图片地址

门店

基本信息

Path： /store

Method： GET

接口描述：

补充diy页面接口的组件数据中id=store的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
navPicUrl	string	必须		导航图标
scorePicUrl	string	必须		评分图标
showName	boolean	必须		是否展示名称
showScore	boolean	必须		是否展示评分
showTel	boolean	必须		是否展示电话
list	object []	必须			item 类型: object
├─ id	integer	必须		门店id
├─ mobile	string	必须		联系方式
├─ name	string	必须		名称
├─ pic_url	string	必须		封面图
├─ score	integer	必须		评分
├─ longitude	string	必须		经度
├─ latitude	string	必须		纬度

预售

基本信息

Path： /advance

Method： GET

接口描述：

补充diy页面接口的组件数据中id=advance的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
buttonColor	string	必须		购买文字按钮颜色
list	object []	必须		商品列表	item 类型: object
├─ id	integer	必须		商品id
├─ goods_warehouse_id	integer	必须		商品库id
├─ mch_id	integer	必须		商品所属商户id
├─ sign	string	必须		商品所属插件标示
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		缩略图
├─ original_price	number	必须		原价
├─ unit	string	必须		单位
├─ page_url	string	必须		商品详情路径
├─ is_level	integer	必须		是否享受会员价	枚举: 1,0 枚举备注: 1--享受 0--否
├─ level_price	number	必须		会员价
├─ price	number	必须		售价
├─ price_content	string	必须		价格显示文本
├─ vip_card_appoint	object	必须		超级会员卡
├─ discount	string	必须		折扣
├─ is_my_vip_card_goods	integer	必须		登录用户是否享受商品折扣
├─ is_vip_card_user	integer	必须		登录用户是不是会员
listStyle	integer	必须		列表样式	枚举: -1,1 枚举备注: -1--列表模式 1--一行一个 2--一行两个
fill	integer	必须		封面图填充方式	枚举: 1,0 枚举备注: 1--填充 0--留白
goodsCoverProportion	string	必须		封面图宽高比例仅在listStyle=1是有效	枚举: 1-1,3-2 枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2
goodsStyle	integer	必须		单品样式	枚举: 1,2,3 枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中
showGoodsName	boolean	必须		是否显示商品名称
showBuyBtn	boolean	必须		是否显示购买按钮
buyBtnStyle	integer	必须		购买按钮样式	枚举: 1,2,3 枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条
buyBtnText	string	必须		购买按钮文本
showGoodsTag	boolean	必须		是否显示角标
customizeGoodsTag	boolean	必须		是否自定义角标
goodsTagPicUrl	string	必须		角标图片地址

预约

基本信息

Path： /booking

Method： GET

接口描述：

补充diy页面接口的组件数据中id=booking的

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
buttonColor	string	必须		购买文字按钮颜色
list	object []	必须		商品列表	item 类型: object
├─ id	integer	必须		商品id
├─ goods_warehouse_id	integer	必须		商品库id
├─ mch_id	integer	必须		商品所属商户id
├─ sign	string	必须		商品所属插件标示
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		缩略图
├─ original_price	number	必须		原价
├─ unit	string	必须		单位
├─ page_url	string	必须		商品详情路径
├─ is_level	integer	必须		是否享受会员价	枚举: 1,0 枚举备注: 1--享受 0--否
├─ level_price	number	必须		会员价
├─ price	number	必须		售价
├─ price_content	string	必须		价格显示文本
├─ vip_card_appoint	object	必须		超级会员卡
├─ discount	string	必须		折扣
├─ is_my_vip_card_goods	integer	必须		登录用户是否享受商品折扣
├─ is_vip_card_user	integer	必须		登录用户是不是会员
listStyle	integer	必须		列表样式	枚举: -1,1 枚举备注: -1--列表模式 1--一行一个 2--一行两个
fill	integer	必须		封面图填充方式	枚举: 1,0 枚举备注: 1--填充 0--留白
goodsCoverProportion	string	必须		封面图宽高比例仅在listStyle=1是有效	枚举: 1-1,3-2 枚举备注: '1-1'--宽高比1:1 '3-2'--宽高比3:2
goodsStyle	integer	必须		单品样式	枚举: 1,2,3 枚举备注: 1--无边框 2--有边框 3--无边框居中 4--有边框居中
showGoodsName	boolean	必须		是否显示商品名称
showBuyBtn	boolean	必须		是否显示购买按钮
buyBtnStyle	integer	必须		购买按钮样式	枚举: 1,2,3 枚举备注: 1--填充 2--线条 3--圆角填充 4--圆角线条
buyBtnText	string	必须		购买按钮文本
showGoodsTag	boolean	必须		是否显示角标
customizeGoodsTag	boolean	必须		是否自定义角标
goodsTagPicUrl	string	必须		角标图片地址

订单管理

订单列表

基本信息

Path： /api/order/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
status	是	0	0.全部

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须		订单ID
├─ mall_id	number	必须		商城ID
├─ user_id	number	必须		用户ID
├─ mch_id	number	必须		商户ID
├─ order_no	string	必须		订单号
├─ total_price	string	必须		订单总金额(含运费)
├─ total_pay_price	string	必须		实际支付总费用(含运费）
├─ express_original_price	string	必须		运费(后台修改前)
├─ express_price	string	必须		运费(后台修改后)
├─ total_goods_price	string	必须		订单商品总金额(优惠后)
├─ total_goods_original_price	string	必须		订单商品总金额(优惠前)
├─ member_discount_price	string	必须		会员优惠价格(正数表示优惠，负数表示加价)
├─ use_user_coupon_id	number	必须		使用的用户优惠券id
├─ coupon_discount_price	string	必须		优惠券优惠金额
├─ use_integral_num	number	必须		使用积分数量
├─ integral_deduction_price	string	必须		积分抵扣金额
├─ name	string	必须		收件人姓名
├─ mobile	string	必须		收件人手机号
├─ address	string	必须		收件人地址
├─ remark	string	必须		用户订单备注
├─ order_form	object []	必须		自定义表单（JSON）	item 类型: object
├─ key	string	必须		表单组件唯一标识
├─ label	string	必须		表单名称
├─ value	string,null	必须		表单值
├─ required	number	必须		表单组件是否必填
├─ words	string	必须		商家留言
├─ seller_remark	string	必须		商家订单备注
├─ is_pay	number	必须		是否支付：0.未支付|1.已支付
├─ pay_type	number	必须		支付方式：1.在线支付 2.货到付款 3.余额支付
├─ pay_time	string	必须		支付时间
├─ is_send	number	必须		是否发货：0.未发货|1.已发货
├─ send_time	string	必须		发货时间
├─ customer_name	string	必须		(已废弃)京东商家编号
├─ express	string	必须		(已废弃)物流公司
├─ express_no	string	必须		(已废弃)物流订单号
├─ is_sale	number	必须		是否过售后时间
├─ is_confirm	number	必须		收货状态：0.未收货|1.已收货
├─ confirm_time	string	必须		确认收货时间
├─ cancel_status	number	必须		订单取消状态：0.未取消|1.已取消|2.申请取消
├─ cancel_time	string	必须		订单取消时间
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	number	必须
├─ is_recycle	number	必须		是否加入回收站 0.否|1.是
├─ send_type	number	必须		是否到店自提：0.否|1.是
├─ offline_qrcode	string	必须		核销码
├─ clerk_id	number	必须		核销员ID
├─ store_id	number	必须		自提门店ID
├─ sign	string	必须		订单标识，用于区分插件
├─ token	string	必须		订单所属队列标识
├─ support_pay_types	string	必须		支持的支付方式，空表示支持系统设置支持的所有方式
├─ is_comment	number	必须		是否评价0.否|1.是
├─ comment_time	string	必须		评价时间
├─ sale_status	number	必须		是否申请售后0.否|1.是
├─ status	number	必须		订单状态|1.已完成|0.进行中不能对订单进行任何操作
├─ back_price	string	必须		后台优惠(正数表示优惠，负数表示加价)
├─ auto_cancel_time	string	必须		自动取消时间
├─ auto_confirm_time	null,string	必须		自动确认收货时间
├─ auto_sales_time	null,string	必须		自动售后时间
├─ distance	number	必须		同城配送距离，-1不在范围内，正数为距离KM
├─ city_mobile	string	必须		同城配送联系方式
├─ location	null	必须		同城配送用户经纬度
├─ city_name	null	必须		城市名称
├─ city_info	null	必须		城市信息
├─ comments	string []	必须		订单评价，用于判断订单是否已评价	item 类型: string
├─		非必须
├─ detail	object []	必须			item 类型: object
├─ id	number	必须		商品详情ID
├─ order_id	number	必须		关联订单ID
├─ goods_id	number	必须		商品ID
├─ num	number	必须		商品数量
├─ unit_price	string	必须		商品单价
├─ total_original_price	string	必须		商品原总价(优惠前)
├─ total_price	string	必须		商品总价(优惠后)
├─ member_discount_price	string	必须		会员优惠金额(正数表示优惠，负数表示加价)
├─ goods_info	object	必须		商品信息josn格式
├─ name	string	非必须		商品名称
├─ attr_list	object []	非必须		已选规格信息	item 类型: object
├─ attr_group_name	string	必须		规格组名
├─ attr_group_id	number	必须		规格组ID
├─ attr_id	number	必须		规格ID
├─ attr_name	string	必须		规格名称
├─ pic_url	string	非必须		商品缩略图
├─ num	number	非必须		商品数量
├─ total_original_price	string	非必须		商品总价（优惠前）
├─ member_discount_price	string	非必须		会员折扣金额
├─ is_delete	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_refund	number	必须		商品是否退款
├─ refund_status	number	必须		售后状态 0--未售后 1--售后中 2--售后结束
├─ back_price	string	必须		售后状态 0--未售后 1--售后中 2--售后结束
├─ sign	string	必须		订单详情标识，用于区分插件
├─ goods_no	string	必须		商品货号
├─ status_text	string	必须		订单状态（汉字）
├─ is_offline	number	必须		发货方式，兼容版本，该字段与send_type相同
├─ detailExpress	object []	必须		订单快递发货信息	item 类型: object
├─ id	number	非必须		订单物流ID
├─ mall_id	number	非必须		商城ID
├─ mch_id	number	非必须		商户ID，大于0则表示为商户
├─ order_id	number	非必须		订单ID
├─ express	string	非必须		物流公司
├─ send_type	number	非必须		发货类型1.快递|2.其它方式
├─ express_no	string	非必须		物流订单号
├─ merchant_remark	string	非必须		商家留言
├─ express_content	string	非必须		物流内容
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ expressRelation	object []	非必须		物流信息关联商品详情	item 类型: object
├─ id	number	非必须
├─ mall_id	number	非必须		商城ID
├─ mch_id	number	非必须		商户ID
├─ order_id	number	非必须		订单ID
├─ order_detail_id	number	非必须		订单详情ID
├─ order_detail_express_id	number	非必须		关联物流详情ID
├─ is_delete	number	非必须
├─ orderDetail	object	非必须		订单详情，与detail相同
├─ id	number	非必须
├─ order_id	number	非必须
├─ goods_id	number	非必须
├─ num	number	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ member_discount_price	string	非必须
├─ goods_info	object	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ goods_attr	object	非必须
├─ id	number	非必须
├─ goods_id	number	非必须
├─ sign_id	string	非必须
├─ stock	number	非必须
├─ price	number	非必须
├─ original_price	string	非必须
├─ no	string	非必须
├─ weight	number	非必须
├─ pic_url	string	非必须
├─ share_commission_first	string	非必须
├─ share_commission_second	string	非必须
├─ share_commission_third	string	非必须
├─ individual_share	number	非必须
├─ share_type	number	非必须
├─ member_price	number	非必须
├─ integral_price	null	非必须
├─ use_integral	null	非必须
├─ discount	string []	非必须			item 类型: string
├─		非必须
├─ extra	string []	非必须			item 类型: string
├─		非必须
├─ goods_warehouse_id	number	非必须
├─ name	string	非必须
├─ cover_pic	string	非必须
├─ detail	string	非必须
├─ pic_list	string	非必须
├─ number	number	非必须
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_refund	number	非必须
├─ refund_status	number	非必须
├─ back_price	string	非必须
├─ sign	string	非必须
├─ goods_no	string	非必须
├─ der_info	object []	必须		物流信息，注释与detailExpress.expressRelation相同	item 类型: object
├─ id	number	非必须
├─ mall_id	number	非必须
├─ mch_id	number	非必须
├─ order_id	number	非必须
├─ order_detail_id	number	非必须
├─ order_detail_express_id	number	非必须
├─ is_delete	number	非必须
├─ orderExpress	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ mch_id	number	非必须
├─ order_id	number	非必须
├─ express	string	非必须
├─ send_type	number	非必须
├─ express_no	string	非必须
├─ merchant_remark	string	非必须
├─ express_content	string	非必须
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

售后用户发货

基本信息

Path： /api/order/refund-send

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	400	售后订单ID
express	text	是	顺风速运	快递公司名称
customer_name	text	是		京东物流必须填写京东商家编码
express_no	text	是	128398213912839	快递单号

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

售后订单详情

基本信息

Path： /api/order/refund-detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	订单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	number	非必须		售后订单ID
├─ mall_id	number	非必须		商城ID
├─ mch_id	number	非必须		商户ID
├─ user_id	number	非必须		用户ID
├─ order_id	number	非必须		关联订单ID
├─ order_detail_id	number	非必须		关联订单详情ID
├─ order_no	string	非必须		售后订单号
├─ type	number	非必须		售后类型：1=退货退款，2=换货
├─ refund_price	string	非必须		退款金额
├─ remark	string	非必须		用户退款备注、说明
├─ pic_list	string	非必须		用户上传图片凭证
├─ status	number	非必须		订单状态 1.待商家处理 2.同意 3.拒绝
├─ status_time	string	非必须		商家处理时间
├─ merchant_remark	string	非必须		商家同意|拒绝备注、理由
├─ is_send	number	非必须		用户是否发货 0.未发货1.已发货
├─ send_time	string	非必须		发货时间
├─ customer_name	string	非必须		京东商家编号
├─ express	string	非必须		快递公司
├─ express_no	string	非必须		快递单号
├─ address_id	number	非必须		退换货地址ID
├─ is_confirm	number	非必须		商家是否确认操作0.未确认|1.已确认
├─ confirm_time	string	非必须		确认时间
├─ is_refund	number	非必须		退货退款时，是否退款
├─ refund_time	string	非必须		退款时间
├─ merchant_customer_name	string	非必须		换货-商家京东商家编号
├─ merchant_express	string	非必须		换货-商家发货快递公司
├─ merchant_express_no	string	非必须		换货-商家发货快递单号
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ status_text	string	非必须		售后订单状态（中文）
├─ detail	object []	非必须		售后退款商品信息	item 类型: object
├─ goods_info	object	必须		商品信息josn格式
├─ name	string	非必须		商品名称
├─ attr_list	object []	非必须		已选规格信息	item 类型: object
├─ attr_group_name	string	必须		规格组名
├─ attr_group_id	number	必须		规格组ID
├─ attr_id	number	必须		规格ID
├─ attr_name	string	必须		规格名称
├─ pic_url	string	非必须		商品缩略图
├─ num	number	非必须		商品数量
├─ total_original_price	string	非必须		商品总价（优惠前）
├─ member_discount_price	string	非必须		会员折扣金额
├─ refundAddress	object	非必须
├─ id	number	非必须		商家收货地址ID
├─ mall_id	number	非必须		商城ID
├─ mch_id	number	非必须		商户ID
├─ name	string	非必须		收件人
├─ address	string	非必须		收件地址
├─ address_detail	string	非必须		地址详情
├─ mobile	string	非必须		联系方式
├─ remark	string	非必须		备注
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ express_list	object []	非必须			item 类型: object
├─ id	number	必须		快递公司ID
├─ name	string	必须		快递公司名称
├─ code	string	必须		快递公司标识

未付款订单支付

基本信息

Path： /api/order/list-pay-data

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	5827	订单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

核销订单确认收款

基本信息

Path： /api/order/clerk-affirm-pay

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	5797	订单ID
action_type	是	1	收款方式：1.小程序端确认收款

返回数据

名称	类型	是否必须	默认值	备注	其他信息

物流公司列表

基本信息

Path： /api/order/express-list_

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须		ID
├─ name	string	必须		物流公司名称
├─ code	string	必须		物流编码

生成售后订单

基本信息

Path： /api/order/refund-submit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	1	订单详情ID
type	text	是	1	售后类型：1.退货退款
pic_list	text	否	["http://wxapp.mianke.me:2002/foal_store/web/uploads/mall195/20191115/c88b29dbfb1b348fa2cdd29048acf31e.png"]	上传凭证图片，一维数组
refund_price	text	否	100	退款金额 type==1 时传入，退款金额不能大于订单支付金额
remark	text	否	备注	备注

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

申请售后

基本信息

Path： /api/order/apply-refund

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	4843	订单详情ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	number	非必须		商品详情ID
├─ order_id	number	非必须		关联订单ID
├─ goods_id	number	非必须		商品ID
├─ num	number	非必须		商品数量
├─ unit_price	string	非必须		商品单价
├─ total_original_price	string	非必须		商品原总价(优惠前)
├─ total_price	string	非必须		商品总价(优惠后)
├─ member_discount_price	string	非必须		会员优惠金额(正数表示优惠，负数表示加价)
├─ goods_info	object	非必须		商品信息josn格式
├─ name	string	非必须		商品名称
├─ attr_list	object []	非必须		已选规格信息	item 类型: object
├─ attr_group_name	string	必须		规格组名
├─ attr_group_id	number	必须		规格组ID
├─ attr_id	number	必须		规格ID
├─ attr_name	string	必须		规格名称
├─ pic_url	string	非必须		商品缩略图
├─ num	number	非必须		商品数量
├─ total_original_price	string	非必须		商品总价（优惠前）
├─ member_discount_price	string	非必须		会员折扣金额
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_refund	number	非必须		商品是否退款
├─ refund_status	number	非必须		售后状态 0--未售后 1--售后中 2--售后结束
├─ back_price	string	非必须		售后状态 0--未售后 1--售后中 2--售后结束
├─ sign	string	非必须		订单详情标识，用于区分插件
├─ goods_no	string	非必须		商品货号
├─ order	object	非必须		订单信息
├─ id	number	非必须		订单ID
├─ mall_id	number	非必须		商城ID
├─ user_id	number	非必须		用户ID
├─ mch_id	number	非必须		商户ID
├─ order_no	string	非必须		订单号
├─ total_price	string	非必须		订单总金额(含运费)
├─ total_pay_price	string	非必须		实际支付总费用(含运费）
├─ express_original_price	string	非必须		运费(后台修改前)
├─ express_price	string	非必须		运费(后台修改后)
├─ total_goods_price	string	非必须		订单商品总金额(优惠后)
├─ total_goods_original_price	string	非必须		订单商品总金额(优惠前)
├─ member_discount_price	string	非必须		会员优惠价格(正数表示优惠，负数表示加价)
├─ use_user_coupon_id	number	非必须		使用的用户优惠券id
├─ coupon_discount_price	string	非必须		优惠券优惠金额
├─ use_integral_num	number	非必须		使用积分数量
├─ integral_deduction_price	string	非必须		积分抵扣金额
├─ name	string	非必须		收件人姓名
├─ mobile	string	非必须		收件人手机号
├─ address	string	非必须		收件人地址
├─ remark	string	非必须		用户订单备注
├─ order_form	object []	非必须		自定义表单（JSON）	item 类型: object
├─ key	string	必须		表单组件唯一标识
├─ label	string	必须		表单名称
├─ value	string,null	必须		表单值
├─ required	number	必须		表单组件是否必填
├─ words	string	非必须		商家留言
├─ seller_remark	string	非必须		商家订单备注
├─ is_pay	number	非必须		是否支付：0.未支付|1.已支付
├─ pay_type	number	非必须		支付方式：1.在线支付 2.货到付款 3.余额支付
├─ pay_time	string	非必须		支付时间
├─ is_send	number	非必须		是否发货：0.未发货|1.已发货
├─ send_time	string	非必须		发货时间
├─ customer_name	string	非必须		(已废弃)京东商家编号
├─ express	string	非必须		(已废弃)物流公司
├─ express_no	string	非必须		(已废弃)物流订单号
├─ is_sale	number	非必须		是否过售后时间
├─ is_confirm	number	非必须		收货状态：0.未收货|1.已收货
├─ confirm_time	string	非必须		确认收货时间
├─ cancel_status	number	非必须		订单取消状态：0.未取消|1.已取消|2.申请取消
├─ cancel_time	string	非必须		订单取消时间
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ is_recycle	number	非必须		是否加入回收站 0.否|1.是
├─ send_type	number	非必须		是否到店自提：0.否|1.是
├─ offline_qrcode	string	非必须		核销码
├─ clerk_id	number	非必须		核销员ID
├─ store_id	number	非必须		自提门店ID
├─ sign	string	非必须		订单标识，用于区分插件
├─ token	string	非必须		订单所属队列标识
├─ support_pay_types	string	非必须		支持的支付方式，空表示支持系统设置支持的所有方式
├─ is_comment	number	非必须		是否评价0.否|1.是
├─ comment_time	string	非必须		评价时间
├─ sale_status	number	非必须		是否申请售后0.否|1.是
├─ status	number	非必须		订单状态|1.已完成|0.进行中不能对订单进行任何操作
├─ back_price	string	非必须		后台优惠(正数表示优惠，负数表示加价)
├─ auto_cancel_time	string	非必须		自动取消时间
├─ auto_confirm_time	null,string	非必须		自动确认收货时间
├─ auto_sales_time	null,string	非必须		自动售后时间
├─ distance	number	非必须		同城配送距离，-1不在范围内，正数为距离KM
├─ city_mobile	string	非必须		同城配送联系方式
├─ location	null	非必须		同城配送用户经纬度
├─ city_name	null	非必须		城市名称
├─ city_info	null	非必须		城市信息
├─ goods	object	非必须		商品信息
├─ id	string	非必须		商品ID
├─ mall_id	string	非必须		商城ID
├─ mch_id	string	非必须		商户ID
├─ goods_warehouse_id	string	非必须		关联商品库ID
├─ status	string	非必须		上架状态：0=下架，1=上架
├─ price	string	非必须		售价
├─ use_attr	string	非必须		是否使用规格：0=不使用，1=使用
├─ attr_groups	string	非必须		商品规格组
├─ goods_stock	string	非必须		商品总库存（规格库存相加）
├─ virtual_sales	string	非必须		已出售量（虚拟销量）
├─ confine_count	string	非必须		购物数量限制
├─ pieces	string	非必须		单品满件包邮
├─ forehead	string	非必须		单口满额包邮
├─ freight_id	string	非必须		运费模板ID
├─ give_integral	string	非必须		赠送积分
├─ give_integral_type	string	非必须		赠送积分类型1.固定值 |2.百分比
├─ forehead_integral	string	非必须		可抵扣积分
├─ forehead_integral_type	string	非必须		可抵扣积分类型1.固定值 |2.百分比
├─ accumulative	string	非必须		允许多件累计折扣
├─ individual_share	string	非必须		是否单独合伙人设置：0=否，1=是
├─ attr_setting_type	string	非必须		合伙人设置类型 0.普通设置|1.详细设置
├─ is_level	string	非必须		是否享受会员价购买
├─ is_level_alone	string	非必须		是否单独设置会员价
├─ share_type	string	非必须		合伙人佣金配比 0--固定金额 1--百分比
├─ sign	string	非必须		商品标示用于区分商品属于什么模块
├─ app_share_pic	string	非必须		商品自定义分享图片
├─ app_share_title	string	非必须		商品自定义分享标题
├─ is_default_services	string	非必须		默认服务 0.否|1.是
├─ sort	string	非必须		商品排序
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须		统计 支付人数
├─ payment_num	string	非必须		统计 支付件数
├─ payment_amount	string	非必须		统计 支付金额
├─ payment_order	string	非必须		支付订单数
├─ confine_order_count	string	非必须		限制下单数量
├─ is_area_limit	string	非必须		是否单独区域购买
├─ area_limit	string	非必须		区域限制详情 json格式
├─ share_level_type	string	非必须		合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_id	string	非必须		自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ goodsWarehouse	object	非必须		商品库商品信息
├─ id	string	非必须		商品库商品ID
├─ mall_id	string	非必须		商城ID
├─ name	string	非必须		商品名称
├─ original_price	string	非必须		商品原价
├─ cost_price	string	非必须		成本价
├─ detail	string	非必须		商品详情json
├─ cover_pic	string	非必须		商品缩略图
├─ pic_url	string	非必须		商品轮播图
├─ video_url	string	非必须		商品视频
├─ unit	string	非必须		商品单位
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ refund_price	string	非必须		售后最多可退款金额

售后订单列表

基本信息

Path： /api/order/list_1573789146528

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
status	是	5	5.售后订单列表

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须		售后订单ID
├─ mall_id	number	必须		商城ID
├─ mch_id	number	必须		商户ID
├─ user_id	number	必须		用户ID
├─ order_id	number	必须		关联订单ID
├─ order_detail_id	number	必须		关联订单详情ID
├─ order_no	string	必须		售后订单号
├─ type	number	必须		售后类型：1=退货退款，2=换货
├─ refund_price	string	必须		退款金额
├─ remark	string	必须		用户退款备注、说明
├─ pic_list	string	必须		用户上传图片凭证
├─ status	number	必须		1.待商家处理 2.同意 3.拒绝
├─ status_time	string	必须		商家处理时间
├─ merchant_remark	string	必须		商家同意|拒绝备注、理由
├─ is_send	number	必须		用户是否发货 0.未发货1.已发货
├─ send_time	string	必须		发货时间
├─ customer_name	string	必须		京东商家编号
├─ express	string	必须		快递公司
├─ express_no	string	必须		快递单号
├─ address_id	number	必须		退换货地址ID
├─ is_confirm	number	必须		商家是否确认操作0.未确认|1.已确认
├─ confirm_time	string	必须		确认时间
├─ is_refund	number	必须		退货退款时，是否退款
├─ refund_time	string	必须		退款时间
├─ merchant_customer_name	string	必须		换货-商家京东商家编号
├─ merchant_express	string	必须		换货-商家发货快递公司
├─ merchant_express_no	string	必须		换货-商家发货快递单号
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	number	必须
├─ status_text	string	必须		售后订单状态（中文）
├─ detail	object []	必须		售后退款商品信息	item 类型: object
├─ goods_info	object	必须		商品信息josn格式
├─ name	string	非必须		商品名称
├─ attr_list	object []	非必须		已选规格信息	item 类型: object
├─ attr_group_name	string	必须		规格组名
├─ attr_group_id	number	必须		规格组ID
├─ attr_id	number	必须		规格ID
├─ attr_name	string	必须		规格名称
├─ pic_url	string	非必须		商品缩略图
├─ num	number	非必须		商品数量
├─ total_original_price	string	非必须		商品总价（优惠前）
├─ member_discount_price	string	非必须		会员折扣金额
├─ reality_refund_price	string	必须		商家实际退款金额
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

订单取消|申请取消

基本信息

Path： /api/order/cancel

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	5864	订单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

订单核销

基本信息

Path： /api/order/order-clerk

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	4284	订单ID
action_type	是	1	1.小程序端确认收款
clerk_remark	否	核销备注	核销备注

返回数据

名称	类型	是否必须	默认值	备注	其他信息

订单核销码

基本信息

Path： /api/order/clerk-qr-code

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	4284	订单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ file_path	string	非必须		核销码链接

订单物流详情

基本信息

Path： /api/order/api/order/express-detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
express	是	顺丰速运	快递公司
customer_name	是		京东商家编号，京东物流查询时需传入
express_no	是	288799311690	物流订单号

返回数据

名称	类型	是否必须	默认值	备注	其他信息

订单确认收货

基本信息

Path： /api/order/confirm

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	5797	订单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

订单评价

基本信息

Path： /api/order/appraise

Method： POST

接口描述：

appraiseData数组对象参数注释

id    订单详情ID
content    评价内容
pic_list    评价图片
grade_level    评分：1=差评，2=中评，3=好
is_anonymous    是否匿名评价 true|false

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
id	是	5827	订单ID

Body

参数名称	参数类型	是否必须	示例	备注
order_id	text	是	5843	订单ID
appraiseData	text	是	[{"id":"6007","content":"123","pic_list":["http://wxapp.mianke.me:2002/foal_store/web/uploads/mall195/20191116/739f2e632cb7b8b19642fe595a23ed45.png"],"grade_level":3,"is_anonymous":true}]	二维数组json格式，具体意思看接口备注

返回数据

名称	类型	是否必须	默认值	备注	其他信息

订单详情

基本信息

Path： /api/order/detail

Method： GET

接口描述：

电子卡密插件---2020-03-19
新增字段：is_show_send_type、type_data、goods_type、is_show_express、is_can_apply_sales；

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	订单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	number	非必须		订单ID
├─ mall_id	number	非必须		商城ID
├─ user_id	number	非必须		用户ID
├─ mch_id	number	非必须		商户ID
├─ order_no	string	非必须		订单号
├─ total_price	string	非必须		订单总金额(含运费)
├─ total_pay_price	string	非必须		实际支付总费用(含运费）
├─ express_original_price	string	非必须		运费(后台修改前)
├─ express_price	string	非必须		运费(后台修改后)
├─ total_goods_price	string	非必须		订单商品总金额(优惠后)
├─ total_goods_original_price	string	非必须		订单商品总金额(优惠前)
├─ member_discount_price	string	非必须		会员优惠价格(正数表示优惠，负数表示加价)
├─ use_user_coupon_id	number	非必须		使用的用户优惠券id
├─ coupon_discount_price	string	非必须		优惠券优惠金额
├─ use_integral_num	number	非必须		使用积分数量
├─ integral_deduction_price	string	非必须		积分抵扣金额
├─ name	string	非必须		收件人姓名
├─ mobile	string	非必须		收件人手机号
├─ address	string	非必须		收件人地址
├─ remark	string	非必须		用户订单备注
├─ order_form	object []	非必须		自定义表单（JSON）	item 类型: object
├─ key	string	必须		表单组件唯一标识
├─ label	string	必须		表单名称
├─ value	string,null	必须		表单值
├─ required	number	必须		表单组件是否必填
├─ words	string	非必须		商家留言
├─ seller_remark	string	非必须		商家订单备注
├─ is_pay	number	非必须		是否支付：0.未支付|1.已支付
├─ pay_type	number	非必须		支付方式：1.在线支付 2.货到付款 3.余额支付
├─ pay_time	string	非必须		支付时间
├─ is_send	number	非必须		是否发货：0.未发货|1.已发货
├─ send_time	string	非必须		发货时间
├─ customer_name	string	非必须		(已废弃)京东商家编号
├─ express	string	非必须		(已废弃)物流公司
├─ express_no	string	非必须		(已废弃)物流订单号
├─ is_sale	number	非必须		是否过售后时间
├─ is_confirm	number	非必须		收货状态：0.未收货|1.已收货
├─ confirm_time	string	非必须		确认收货时间
├─ cancel_status	number	非必须		订单取消状态：0.未取消|1.已取消|2.申请取消
├─ cancel_time	string	非必须		订单取消时间
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ is_recycle	number	非必须		是否加入回收站 0.否|1.是
├─ send_type	number	非必须		是否到店自提：0.否|1.是
├─ offline_qrcode	string	非必须		核销码
├─ clerk_id	number	非必须		核销员ID
├─ store_id	number	非必须		自提门店ID
├─ sign	string	非必须		订单标识，用于区分插件
├─ token	string	非必须		订单所属队列标识
├─ support_pay_types	string	非必须		支持的支付方式，空表示支持系统设置支持的所有方式
├─ is_comment	number	非必须		是否评价0.否|1.是
├─ comment_time	string	非必须		评价时间
├─ sale_status	number	非必须		是否申请售后0.否|1.是
├─ status	number	非必须		订单状态|1.已完成|0.进行中不能对订单进行任何操作
├─ back_price	string	非必须		后台优惠(正数表示优惠，负数表示加价)
├─ auto_cancel_time	string	非必须		自动取消时间
├─ auto_confirm_time	null,string	非必须		自动确认收货时间
├─ auto_sales_time	null,string	非必须		自动售后时间
├─ distance	number	非必须		同城配送距离，-1不在范围内，正数为距离KM
├─ city_mobile	string	非必须		同城配送联系方式
├─ location	null	非必须		同城配送用户经纬度
├─ city_name	null	非必须		城市名称
├─ city_info	null	非必须		城市信息
├─ detail	object []	非必须			item 类型: object
├─ id	number	必须		商品详情ID
├─ order_id	number	必须		关联订单ID
├─ goods_id	number	必须		商品ID
├─ num	number	必须		商品数量
├─ unit_price	string	必须		商品单价
├─ total_original_price	string	必须		商品原总价(优惠前)
├─ total_price	string	必须		商品总价(优惠后)
├─ member_discount_price	string	必须		会员优惠金额(正数表示优惠，负数表示加价)
├─ goods_info	object	必须		商品信息josn格式
├─ name	string	非必须		商品名称
├─ attr_list	object []	非必须		已选规格信息	item 类型: object
├─ attr_group_name	string	必须		规格组名
├─ attr_group_id	number	必须		规格组ID
├─ attr_id	number	必须		规格ID
├─ attr_name	string	必须		规格名称
├─ pic_url	string	非必须		商品缩略图
├─ num	number	非必须		商品数量
├─ total_original_price	string	非必须		商品总价（优惠前）
├─ member_discount_price	string	非必须		会员折扣金额
├─ is_delete	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_refund	number	必须		商品是否退款
├─ refund_status	number	必须		售后状态 0--未售后 1--售后中 2--售后结束
├─ back_price	string	必须		售后状态 0--未售后 1--售后中 2--售后结束
├─ sign	string	必须		订单详情标识，用于区分插件
├─ goods_no	string	必须		商品货号
├─ order	object	必须
├─ id	number	非必须		订单ID
├─ mall_id	number	非必须		商城ID
├─ user_id	number	非必须		用户ID
├─ mch_id	number	非必须		商户ID
├─ order_no	string	非必须		订单号
├─ total_price	string	非必须		订单总金额(含运费)
├─ total_pay_price	string	非必须		实际支付总费用(含运费）
├─ express_original_price	string	非必须		运费(后台修改前)
├─ express_price	string	非必须		运费(后台修改后)
├─ total_goods_price	string	非必须		订单商品总金额(优惠后)
├─ total_goods_original_price	string	非必须		订单商品总金额(优惠前)
├─ member_discount_price	string	非必须		会员优惠价格(正数表示优惠，负数表示加价)
├─ use_user_coupon_id	number	非必须		使用的用户优惠券id
├─ coupon_discount_price	string	非必须		优惠券优惠金额
├─ use_integral_num	number	非必须		使用积分数量
├─ integral_deduction_price	string	非必须		积分抵扣金额
├─ name	string	非必须		收件人姓名
├─ mobile	string	非必须		收件人手机号
├─ address	string	非必须		收件人地址
├─ remark	string	非必须		用户订单备注
├─ order_form	object []	非必须		自定义表单（JSON）	item 类型: object
├─ key	string	必须		表单组件唯一标识
├─ label	string	必须		表单名称
├─ value	string,null	必须		表单值
├─ required	number	必须		表单组件是否必填
├─ words	string	非必须		商家留言
├─ seller_remark	string	非必须		商家订单备注
├─ is_pay	number	非必须		是否支付：0.未支付|1.已支付
├─ pay_type	number	非必须		支付方式：1.在线支付 2.货到付款 3.余额支付
├─ pay_time	string	非必须		支付时间
├─ is_send	number	非必须		是否发货：0.未发货|1.已发货
├─ send_time	string	非必须		发货时间
├─ customer_name	string	非必须		(已废弃)京东商家编号
├─ express	string	非必须		(已废弃)物流公司
├─ express_no	string	非必须		(已废弃)物流订单号
├─ is_sale	number	非必须		是否过售后时间
├─ is_confirm	number	非必须		收货状态：0.未收货|1.已收货
├─ confirm_time	string	非必须		确认收货时间
├─ cancel_status	number	非必须		订单取消状态：0.未取消|1.已取消|2.申请取消
├─ cancel_time	string	非必须		订单取消时间
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ is_recycle	number	非必须		是否加入回收站 0.否|1.是
├─ send_type	number	非必须		是否到店自提：0.否|1.是
├─ offline_qrcode	string	非必须		核销码
├─ clerk_id	number	非必须		核销员ID
├─ store_id	number	非必须		自提门店ID
├─ sign	string	非必须		订单标识，用于区分插件
├─ token	string	非必须		订单所属队列标识
├─ support_pay_types	string	非必须		支持的支付方式，空表示支持系统设置支持的所有方式
├─ is_comment	number	非必须		是否评价0.否|1.是
├─ comment_time	string	非必须		评价时间
├─ sale_status	number	非必须		是否申请售后0.否|1.是
├─ status	number	非必须		订单状态|1.已完成|0.进行中不能对订单进行任何操作
├─ back_price	string	非必须		后台优惠(正数表示优惠，负数表示加价)
├─ auto_cancel_time	string	非必须		自动取消时间
├─ auto_confirm_time	null,string	非必须		自动确认收货时间
├─ auto_sales_time	null,string	非必须		自动售后时间
├─ distance	number	非必须		同城配送距离，-1不在范围内，正数为距离KM
├─ city_mobile	string	非必须		同城配送联系方式
├─ location	null	非必须		同城配送用户经纬度
├─ city_name	null	非必须		城市名称
├─ city_info	null	非必须		城市信息
├─ goods	object	必须
├─ id	string	非必须		商品ID
├─ mall_id	string	非必须		商城ID
├─ mch_id	string	非必须		商户ID
├─ goods_warehouse_id	string	非必须		关联商品库ID
├─ status	string	非必须		上架状态：0=下架，1=上架
├─ price	string	非必须		售价
├─ use_attr	string	非必须		是否使用规格：0=不使用，1=使用
├─ attr_groups	string	非必须		商品规格组
├─ goods_stock	string	非必须		商品总库存（规格库存相加）
├─ virtual_sales	string	非必须		已出售量（虚拟销量）
├─ confine_count	string	非必须		购物数量限制
├─ pieces	string	非必须		单品满件包邮
├─ forehead	string	非必须		单口满额包邮
├─ freight_id	string	非必须		运费模板ID
├─ give_integral	string	非必须		赠送积分
├─ give_integral_type	string	非必须		赠送积分类型1.固定值 |2.百分比
├─ forehead_integral	string	非必须		可抵扣积分
├─ forehead_integral_type	string	非必须		可抵扣积分类型1.固定值 |2.百分比
├─ accumulative	string	非必须		允许多件累计折扣
├─ individual_share	string	非必须		是否单独合伙人设置：0=否，1=是
├─ attr_setting_type	string	非必须		合伙人设置类型 0.普通设置|1.详细设置
├─ is_level	string	非必须		是否享受会员价购买
├─ is_level_alone	string	非必须		是否单独设置会员价
├─ share_type	string	非必须		合伙人佣金配比 0--固定金额 1--百分比
├─ sign	string	非必须		商品标示用于区分商品属于什么模块
├─ app_share_pic	string	非必须		商品自定义分享图片
├─ app_share_title	string	非必须		商品自定义分享标题
├─ is_default_services	string	非必须		默认服务 0.否|1.是
├─ sort	string	非必须		商品排序
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须		统计 支付人数
├─ payment_num	string	非必须		统计 支付件数
├─ payment_amount	string	非必须		统计 支付金额
├─ payment_order	string	非必须		支付订单数
├─ confine_order_count	string	非必须		限制下单数量
├─ is_area_limit	string	非必须		是否单独区域购买
├─ area_limit	string	非必须		区域限制详情 json格式
├─ share_level_type	string	非必须		合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_id	string	非必须		自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ goodsWarehouse	object	非必须		商品库商品信息
├─ id	string	非必须		商品库商品ID
├─ mall_id	string	非必须		商城ID
├─ name	string	非必须		商品名称
├─ original_price	string	非必须		商品原价
├─ cost_price	string	非必须		成本价
├─ detail	string	非必须		商品详情json
├─ cover_pic	string	非必须		商品缩略图
├─ pic_url	string	非必须		商品轮播图
├─ video_url	string	非必须		商品视频
├─ unit	string	非必须		商品单位
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ refund	null	必须		是否退款0.否|1.是
├─ store	null	非必须		自提门店信息
├─ detailExpress	object []	非必须			item 类型: object
├─ id	number	必须		订单物流ID
├─ mall_id	number	必须		商城ID
├─ mch_id	number	必须		商户ID，大于0则表示为商户
├─ order_id	number	必须		订单ID
├─ express	string	必须		物流公司
├─ send_type	number	必须		发货类型1.快递|2.其它方式
├─ express_no	string	必须		物流订单号
├─ merchant_remark	string	必须		商家留言
├─ express_content	string	必须		物流内容
├─ is_delete	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ expressRelation	object []	必须		详情关联物流信息	item 类型: object
├─ id	number	必须
├─ mall_id	number	必须		商城ID
├─ mch_id	number	必须		商户ID
├─ order_id	number	必须		订单ID
├─ order_detail_id	number	必须		订单详情ID
├─ order_detail_express_id	number	必须		关联物流详情ID
├─ is_delete	number	必须
├─ orderDetail	object	必须
├─ id	number	非必须		商品详情ID
├─ order_id	number	非必须		关联订单ID
├─ goods_id	number	非必须		商品ID
├─ num	number	非必须		商品数量
├─ unit_price	string	非必须		商品单价
├─ total_original_price	string	非必须		商品原总价(优惠前)
├─ total_price	string	非必须		商品总价(优惠后)
├─ member_discount_price	string	非必须		会员优惠金额(正数表示优惠，负数表示加价)
├─ goods_info	object	非必须		商品信息josn格式
├─ name	string	非必须		商品名称
├─ attr_list	object []	非必须		已选规格信息	item 类型: object
├─ attr_group_name	string	必须		规格组名
├─ attr_group_id	number	必须		规格组ID
├─ attr_id	number	必须		规格ID
├─ attr_name	string	必须		规格名称
├─ pic_url	string	非必须		商品缩略图
├─ num	number	非必须		商品数量
├─ total_original_price	string	非必须		商品总价（优惠前）
├─ member_discount_price	string	非必须		会员折扣金额
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_refund	number	非必须		商品是否退款
├─ refund_status	number	非必须		售后状态 0--未售后 1--售后中 2--售后结束
├─ back_price	string	非必须		售后状态 0--未售后 1--售后中 2--售后结束
├─ sign	string	非必须		订单详情标识，用于区分插件
├─ goods_no	string	非必须		商品货号
├─ detailExpressRelation	object []	非必须			item 类型: object
├─ id	number	必须
├─ mall_id	number	必须		商城ID
├─ mch_id	number	必须		商户ID
├─ order_id	number	必须		订单ID
├─ order_detail_id	number	必须		订单详情ID
├─ order_detail_express_id	number	必须		关联物流详情ID
├─ is_delete	number	必须
├─ vipCardDiscount	string []	非必须			item 类型: string
├─		非必须
├─ status_text	string	非必须		订单状态（中文）
├─ pay_type_text	string	非必须
├─ goods_num	number	非必须		商品数量
├─ member_deduction_price_count	string	非必须		会员抵扣价格
├─ city	null	非必须		城市
├─ plugin_data	string []	非必须		插件相关数据	item 类型: string
├─		非必须
├─ is_offline	string	非必须		兼容旧版本 该字段与send_type相同
├─ is_show_send_type	integer	非必须		是否显示配送方式	枚举: 0,1 枚举备注: 0--不显示 1--显示
├─ type_data	object	非必须
├─ ecard	object []	必须		电子卡密信息	item 类型: object
├─ key	string	必须		卡密字段
├─ value	string	必须		卡密数据
├─ goods_type	string	非必须		商品类型	枚举: goods,ecard 枚举备注: goods--实体商品 ecard--电子卡密
├─ is_can_apply_sales	integer	非必须		是否显示售后按钮 0--否 1--是
├─ is_show_express	integer	非必须		是否展示运费 0--否 1--是

裂变红包

分享赠送

基本信息

Path： /plugin/fxhb/api/index/share-send

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	7	活动id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ card_list	object []	非必须		赠送的卡券	item 类型: object
├─ mall_id	number	必须		商城id
├─ user_id	number	必须		用户id
├─ card_id	number	必须		卡券id
├─ name	string	必须		卡券名称
├─ pic_url	string	必须		卡券封面
├─ content	string	必须		卡券内容
├─ created_at	string	必须
├─ is_use	number	必须		是否使用 0未使用 1已使用
├─ clerk_id	number	必须		核销
├─ store_id	number	必须		门店
├─ clerked_at	string	必须
├─ order_id	number	必须
├─ order_detail_id	number	必须
├─ data	string	必须
├─ start_time	string	必须
├─ end_time	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ id	number	必须
├─ user_coupon_list	object []	非必须		赠送优惠券	item 类型: object
├─ id	number	必须
├─ mall_id	number	必须
├─ name	string	必须
├─ type	number	必须
├─ discount	string	必须
├─ discount_limit	string	必须
├─ pic_url	number	必须
├─ desc	string	必须
├─ min_price	string	必须
├─ sub_price	string	必须
├─ total_count	number	必须
├─ sort	number	必须
├─ expire_type	number	必须
├─ expire_day	number	必须
├─ begin_time	string	必须
├─ end_time	string	必须
├─ appoint_type	number	必须
├─ rule	string	必须
├─ is_member	number	必须
├─ is_delete	number	必须
├─ deleted_at	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ content	string	必须
├─ send_balance	string	非必须		赠送余额
├─ send_integral_num	string	非必须		赠送积分

后台新增/编辑活动

基本信息

Path： /plugin/fxhb/mall/activity/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
form	text	是	{"cat_id_list":[],"goods_id_list":[],"status":"0","type":"1","number":4,"effective_time":30,"open_effective_time":24,"coupon_type":"3","sponsor_num":-1,"help_num":-1,"sponsor_count":-1,"sponsor_count_type":"0","share_title":"11111","pic_url":"http://localhost/foal_store/web/uploads/mall1/20191123/2f02c09396fbf2ae7f454658f32a78db.jpg","start_end_time":["2019-12-04","2019-12-06"],"name":"哈哈","remark":"fd","count_price":"111","least_price":"11","share_pic_url":"http://localhost/foal_store/web/uploads/mall1/20191123/2f02c09396fbf2ae7f454658f32a78db.jpg",

"send_type":1,
"send_num":100,
"coupons":[{"id":"1","coupon_id":"5","send_num":"2","is_delete":"0","name":"测试优惠券"}],"cards":[{"id":"1","card_id":"1","send_num":"3","is_delete":"0","name":"aaa"}]
,"id":7} | 赠送优惠券： "coupons":[{"id":"1","coupon_id":"5","send_num":"2","is_delete":"0","name":"测试优惠券"}]

赠送卡券："cards":[{"id":"1","card_id":"1","send_num":"3","is_delete":"0","name":"aaa"}]

"send_type":0不赠送 1赠送余额 2赠送积分
"send_num":赠送数量 |

返回数据

名称	类型	是否必须	默认值	备注	其他信息

拆红包

基本信息

Path： /fxhb/api/index/join

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Body

参数名称	参数类型	是否必须	示例	备注
user_activity_id	text	否		分享用户的活动id

返回数据

名称	类型	是否必须	默认值	备注	其他信息

拆红包结果

基本信息

Path： /fxhb/api/index/join-result

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
queueId	是
token	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

拆红包详情

基本信息

Path： /fxhb/api/index/detail

Method： GET

接口描述：

拆红包详情

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
user_activity_id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ nickname	string	非必须		参与用户昵称
├─ avatar	string	非必须		参与用户头像
├─ get_price	number	非必须		参与用户瓜分金额
├─ max	number	非必须		是否是最大值
├─ status	number	非必须		拆红包状态0--进行中 1--成功 2--失败
├─ is_join	number	非必须		当前用户是否参与拆红包0--否 1--是
├─ min_price	string	非必须		红包使用最小值
├─ user_price	string	非必须		当前用户红包金额
├─ reset_time	integer	非必须		剩余时间（秒）
├─ is_my_hongbao	integer	非必须		是否是本人发起的
├─ coupon_total_money	number	非必须		红包总额
├─ user_num	number	非必须		剩余人数

活动配置

基本信息

Path： /fxhb/api/index/index

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ config	object	非必须		当前拆红包活动配置
├─ id	number	非必须		活动id
├─ number	number	非必须		拆包人数
├─ count_price	string	非必须		红包总金额
├─ share_title	string	非必须		分享标题
├─ share_pic_url	string	非必须		分享图片
├─ pic_url	string	非必须		活动图片
├─ remark	string	非必须		活动规则
├─ user_activity_id	string	非必须		用户参与的拆红包活动ID 若没有则为null

订单后台

售后列表

基本信息

Path： /order/refund

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
status	是	0	-1全部 0未处理 1 已处理 2代发货 3待收货
user_id	是
date_start	是
date_end	是
keyword	是
keyword_1	是		1 订单号搜索 2 昵称搜索 3名称搜索4订单id搜索5 6收件人号码搜索

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须		售后订单列表(详情见售后表)	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ order_id	string	必须
├─ order_detail_id	string	必须
├─ order_no	string	必须
├─ type	string	必须
├─ refund_price	string	必须
├─ remark	string	必须
├─ pic_list	string	必须
├─ status	string	必须
├─ status_time	string	必须
├─ merchant_remark	string	必须
├─ is_send	string	必须
├─ send_time	string	必须
├─ express	string	必须
├─ express_no	string	必须
├─ address_id	string	必须
├─ is_confirm	string	必须
├─ confirm_time	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ name	string	必须		收件人
├─ mobile	string	必须		电话号码
├─ address	string	必须		地址
├─ pay_type	string	必须		支付方式
├─ detail	object	必须		订单详情
├─ id	string	非必须
├─ order_id	string	非必须
├─ goods_id	string	非必须
├─ num	string	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ member_discount_price	string	非必须
├─ goods_info	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ price	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ status	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ virtual_sales	string	非必须
├─ sort	string	非必须
├─ is_quick_shop	string	非必须
├─ is_sell_well	string	非必须
├─ is_level	string	非必须
├─ confine_count	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ is_negotiable	string	非必须
├─ freight_id	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ address	object []	非必须		后台收货地址	item 类型: object
├─ id	number	必须
├─ mall_id	number	必须
├─ mch_id	number	必须
├─ name	string	必须
├─ address	string	必须
├─ mobile	string	必须
├─ remark	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	number	必须
├─ exportList	string []	非必须			item 类型: string
├─		非必须

售后处理

基本信息

Path： /order/refund-handle

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
order_refund_id	text	是
type	text	是		1退货 2 换货
is_agree	text	是		1同意 0拒绝
refund	text	是		1退货 2退货退款
refund_price	text	是		退货价格 为空表示原支付价
address_id	text	是		地址ID
merchant_remark	text	是		商家同意

返回数据

名称	类型	是否必须	默认值	备注	其他信息

订单列表

基本信息

Path： /order/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
status	否		-1全部 0未付款 1待发货 2待收货 3已完成 4待处理/待退款 5已取消 7 回收站
store_id	否		门店id
date_start	是		开始时间 y-m-sH:i:s
date_end	是
clerk_id	是		核销员id
user_id	是		用户id
is_offline	是		是否到店自提：0.否
keyword	是
keyword_1	是		1 订单号搜索 2 昵称搜索 3名称搜索4订单id搜索5 商品搜索6收件人号码搜索

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ mch_id	string	必须
├─ order_no	string	必须
├─ total_price	string	必须
├─ total_pay_price	string	必须
├─ express_price	string	必须
├─ total_goods_price	string	必须
├─ total_goods_original_price	string	必须
├─ member_discount_price	string	必须
├─ use_user_coupon_id	string	必须
├─ coupon_discount_price	string	必须
├─ use_integral_num	string	必须
├─ integral_deduction_price	string	必须
├─ name	string	必须
├─ mobile	string	必须
├─ address	string	必须
├─ remark	string	必须
├─ order_form	object,null	必须
├─ words	string	必须
├─ seller_remark	string	必须
├─ is_pay	string	必须
├─ pay_type	string	必须
├─ pay_time	string	必须
├─ is_send	string	必须
├─ send_time	string	必须
├─ express	string	必须
├─ express_no	string	必须
├─ is_sale	string	必须
├─ is_confirm	string	必须
├─ confirm_time	string	必须
├─ cancel_status	string	必须
├─ cancel_time	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_recycle	string	必须
├─ is_offline	string	必须
├─ offline_qrcode	string	必须
├─ clerk_id	string	必须
├─ store_id	string	必须
├─ token	string	必须
├─ nickname	string	必须		用户昵称
├─ detail	object []	必须		订单详情信息（备注见order_detail）	item 类型: object
├─ id	string	必须
├─ order_id	string	必须
├─ goods_id	string	必须
├─ num	string	必须
├─ unit_price	string	必须
├─ total_original_price	string	必须
├─ total_price	string	必须
├─ member_discount_price	string	必须
├─ goods_info	string	必须
├─ is_delete	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ goods	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ price	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ status	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ virtual_sales	string	非必须
├─ sort	string	非必须
├─ is_quick_shop	string	非必须
├─ is_sell_well	string	非必须
├─ is_level	string	非必须
├─ confine_count	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ is_negotiable	string	非必须
├─ freight_id	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ refund	null	必须		商品售后情况
├─ attr_list	object []	必须		商品规格	item 类型: object
├─ attr_group_name	string	必须		规格组
├─ attr_group_id	number,string	必须
├─ attr_id	number,string	必须
├─ attr_name	string	必须		规格名
├─ clerk	object	必须		核销人信息
├─ field_2	string	必须
├─ store	object	必须		门店信息
├─ exportList	string []	非必须		导出信息（未处理）	item 类型: string
├─		非必须

订单详情后台

基本信息

Path： /order/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
order_id	是	订单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ order	object	非必须		详见order表
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ mch_id	string	非必须
├─ order_no	string	非必须
├─ total_price	string	非必须
├─ total_pay_price	string	非必须
├─ express_price	string	非必须
├─ total_goods_price	string	非必须
├─ total_goods_original_price	string	非必须
├─ member_discount_price	string	非必须
├─ use_user_coupon_id	string	非必须
├─ coupon_discount_price	string	非必须
├─ use_integral_num	string	非必须
├─ integral_deduction_price	string	非必须
├─ name	string	非必须		收件人
├─ mobile	string	非必须		手机号码
├─ address	string	非必须		地址
├─ remark	string	非必须
├─ words	string	非必须		商家留言
├─ seller_remark	string	非必须		商家订单备注
├─ is_pay	string	非必须		是否支付：0.未支付|1.已支付
├─ pay_type	string	非必须
├─ pay_time	string	非必须		支付时间
├─ is_send	string	非必须
├─ send_time	string	非必须
├─ express	string	非必须
├─ express_no	string	非必须
├─ is_sale	string	非必须
├─ is_confirm	string	非必须
├─ confirm_time	string	非必须
├─ cancel_status	string	非必须
├─ cancel_time	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ is_recycle	string	非必须
├─ is_offline	string	非必须
├─ offline_qrcode	string	非必须
├─ clerk_id	string	非必须
├─ store_id	string	非必须
├─ token	string	非必须
├─ user	object	非必须		用户信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ detail	object []	非必须			item 类型: object
├─ id	string	非必须
├─ order_id	string	非必须
├─ goods_id	string	非必须
├─ num	string	非必须
├─ unit_price	string	非必须
├─ total_original_price	string	非必须
├─ total_price	string	非必须
├─ member_discount_price	string	非必须
├─ goods_info	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ goods	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ name	string	非必须
├─ price	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ status	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	object []	非必须		商品轮播图	item 类型: object
├─ id	string	必须
├─ pic_url	string	必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ virtual_sales	string	非必须
├─ sort	string	非必须
├─ is_quick_shop	string	非必须
├─ is_sell_well	string	非必须
├─ is_level	string	非必须
├─ confine_count	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ is_negotiable	string	非必须
├─ freight_id	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ refund	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ order_detail_id	string	非必须
├─ order_no	string	非必须
├─ type	string	非必须
├─ refund_price	string	非必须
├─ remark	string	非必须
├─ pic_list	string	非必须
├─ status	string	非必须
├─ status_time	string	非必须
├─ refuse_remark	string	非必须
├─ is_send	string	非必须
├─ send_time	string	非必须
├─ express	string	非必须
├─ express_no	string	非必须
├─ address_id	string	非必须
├─ is_confirm	string	非必须
├─ confirm_time	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ attr_list	object []	非必须		规格信息	item 类型: object
├─ attr_group_name	string	必须		规格组
├─ attr_group_id	string,number	必须
├─ attr_id	string,number	必须
├─ attr_name	string	必须		规格名
├─ refund	string	非必须		0未售后，1.待商家处理 2.同意 3.拒绝
├─ order_form	string []	非必须		订单form（未处理）	item 类型: string
├─		非必须
├─ mch	string []	非必须		多商户（未处理）	item 类型: string
├─		非必须

步数宝后台

活动解散

基本信息

Path： /step/mall/activity/disband

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

商品列表

基本信息

Path： /step/mall/goods/search

Method： GET

接口描述：
undefined

请求参数

商品编辑预览

基本信息

Path： /step/mall/goods/edit

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ currency	string	非必须		活力币数量
├─ goods_id	number	非必须		商品id
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须

基本设置列表

基本信息

Path： /plugin/step/mall/setting

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须		详见step_setting表
├─ id	number	非必须
├─ mall_id	number	非必须
├─ convert_max	number	非必须
├─ convert_ratio	number	非必须
├─ currency_name	string	非必须
├─ activity_pic	string	非必须
├─ ranking_pic	string	非必须
├─ qrcode_pic	object []	非必须			item 类型: object
├─ pic_url	string	必须
├─ link_url	string	必须
├─ invite_ratio	number	非必须
├─ remind_at	string	非必须
├─ rule	string	非必须
├─ activity_rule	string	非必须
├─ ranking_num	number	非必须
├─ title	string	非必须
├─ share_title	string	非必须
├─ qrcode_title	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

基本设置提交

基本信息

Path： /step/mall/setting

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
convert_max	text	是	1	每日最高兑换数
convert_ratio	text	是	1	兑换比率
currency_name	text	是	1	活力币别名
activity_pic	text	是	1	活动背景
ranking_pic	text	是	1	排行榜背景
qrcode_pic	text	是	1	海报缩略图(暂定为json数组)
invite_ratio	text	是	22	邀请比率
remind_at	text	是	12	提醒时间
rule	text	是	1	规则
activity_rule	text	是	1	活动规则
ranking_num	text	是	1	全国排行限制
title	text	是	1	小程序标题
share_title	text	是	1	转发标题
qrcode_title	text	是	1	海报文字

返回数据

名称	类型	是否必须	默认值	备注	其他信息

步数币修改

基本信息

Path： /step/mall/user/edit-currency

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
type	text	是	1	1加 2减
step_id	text	是	1	步数宝用户id
currency	text	是	1	金额

返回数据

名称	类型	是否必须	默认值	备注	其他信息

活动保存

基本信息

Path： /step/mall/step/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
title	text	是	1	活动标题
status	text	是	0	0关闭 1开启
begin_at	text	是	2018/20/10 1:1:1	开始时间
end_at	text	是	2018/20/10 1:1:1	结束时间
currency	text	否	1	奖金池
step_num	text	是	0	挑战步数
bail_currency	text	否	1	保证金

返回数据

名称	类型	是否必须	默认值	备注	其他信息

活动列表

基本信息

Path： /step/mall/activity

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须		详见step-activity	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ title	string	必须
├─ currency	string	必须
├─ step_num	string	必须
├─ bail_currency	string	必须
├─ status	string	必须
├─ type	string	必须
├─ begin_at	string	必须
├─ end_at	string	必须
├─ is_delete	string	必须
├─ created_at	string	必须
├─ deleted_at	string	必须
├─ activity_type	string	必须		1完成2解散4关闭5未开始6进行中

活动删除

基本信息

Path： /step/mall/activity/destroy

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	1

活动参与名单

基本信息

Path： /step/mall/activity/partake-list

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ step_id	string	非必须
├─ activity_id	string	非必须
├─ step_currency	string	非必须		报名费
├─ status	string	非必须		0报名 1成功 2失败
├─ created_at	string	非必须
├─ raffled_at	string	非必须
├─ total_num	string	非必须		总步数
├─ step	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ ratio	string	非必须
├─ step_currency	string	非必须
├─ parent_id	string	非必须
├─ invite_ratio	string	非必须
├─ is_remind	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ user	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

活动编辑

基本信息

Path： /step/mall/activity/edit

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须		详见step-activity
├─ list	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ title	string	非必须
├─ currency	string	非必须
├─ step_num	number	非必须
├─ bail_currency	string	非必须
├─ status	number	非必须
├─ type	number	非必须
├─ begin_at	string	非必须
├─ end_at	string	非必须
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须

商品编辑提交

基本信息

Path： /step/mall/goods/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
currency	text	是	1	活力币金额位置待确认 （其他参数详见bargain-goods-edit）

返回数据

名称	类型	是否必须	默认值	备注	其他信息

活动首页状态

基本信息

Path： /step/mall/activity/edit-status

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	1
status	text	是	1	0关闭

流量主列表

基本信息

Path： /step/mall/ad

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ unit_id	string	非必须		模板号
├─ site	string	非必须		select 位置关联
├─ status	string	非必须		0关闭 1开启
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ select	object []	非必须		select(可更换名称)	item 类型: object
├─ value	number	必须
├─ name	string	必须

流量主删除

基本信息

Path： /step/mall/ad/destroy

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是

流量主编辑详情

基本信息

Path： /step/mall/ad/edit

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ unit_id	string	非必须
├─ site	number	非必须
├─ status	number	非必须
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ select	object []	非必须		select(看更换名称)	item 类型: object
├─ value	number	必须
├─ name	string	必须

流量主编辑详情提交

基本信息

Path： /step/mall/ad/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	id	1
status	text	是	0	状态 0关
site	text	是	1	select 位置
unit_id	text	是	3213123	模板id

返回数据

名称	类型	是否必须	默认值	备注	其他信息

流量主首页切换

基本信息

Path： /step/mall/ad/edit-status

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	1
status	text	是	1	0关闭 1开启

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

用户中心

基本信息

Path： /step/mall/user

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ ratio	string	非必须
├─ step_currency	string	非必须
├─ parent_id	string	非必须
├─ invite_ratio	string	非必须
├─ is_remind	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ child_num	string	非必须		邀请人数
├─ user	object	非必须		用户信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

用户兑换记录

基本信息

Path： /step/mall/user/log

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是		step_user_id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ step_id	string	非必须
├─ type	string	非必须		1收入 2 支出
├─ currency	string	非必须		货币
├─ remark	string	非必须		详情
├─ data	string	非必须
├─ created_at	string	非必须

用户邀请记录

基本信息

Path： /step/mall/user/invite

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须
├─ invite_list	object []	非必须		邀请列表	item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ ratio	string	非必须
├─ step_currency	string	非必须
├─ parent_id	string	非必须
├─ invite_ratio	string	非必须
├─ is_remind	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ user	object	非必须		个人信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须

轮播图列表

基本信息

Path： /step/mall/banner

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须		同之前
├─ list	string []	非必须			item 类型: string
├─		非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

轮播图编辑

基本信息

Path： /step/mall/banner/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
ids	text	是	[{}]	同之前

返回数据

名称	类型	是否必须	默认值	备注	其他信息

步数宝前端

活动提交

基本信息

Path： /step/api/step/activity-submit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
activity_id	text	是		活动id
num	text	是		真实步数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	number	非必须		提交步数

参加活动

基本信息

Path： /step/api/step/activity-join

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
activity_id	是	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

商品详情

基本信息

Path： /step/api/step/goods-detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须
├─ attr_group	object []	非必须		规格组	item 类型: object
├─ attr_group_id	number	非必须
├─ attr_group_name	string	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ attr	object []	非必须		规格信息	item 类型: object
├─ id	number	非必须
├─ goods_id	number	非必须
├─ sign_id	string	非必须
├─ stock	number	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	number	非必须
├─ pic_url	string	非必须
├─ is_delete	number	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ member_price_2	number	非必须
├─ price_member	number	非必须
├─ member_price_3	number	非必须
├─ member_price_4	number	非必须
├─ member_price_5	number	非必须
├─ member_price_6	number	非必须
├─ member_price_7	number	非必须
├─ member_price_8	number	非必须
├─ member_price_9	number	非必须
├─ member_price_10	number	非必须
├─ member_price_11	number	非必须
├─ member_price_12	number	非必须
├─ member_price_13	number	非必须
├─ member_price_14	number	非必须
├─ name	string	非必须
├─ pic_url	object []	非必须			item 类型: object
├─ id	string	必须
├─ pic_url	string	必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ price	string	非必须		价格
├─ detail	string	非必须		详情
├─ goods_id	number	非必须
├─ currency	string	非必须		活力币金额
├─ id	number	非必须		步数宝商品id

基本配置

基本信息

Path： /step/api/step/setting

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ convert_max	string	非必须
├─ convert_ratio	string	非必须
├─ currency_name	string	非必须
├─ activity_pic	string	非必须
├─ ranking_pic	string	非必须
├─ qrcode_pic	object []	非必须		海报图	item 类型: object
├─ pic_url	string	必须
├─ link_url	string	必须
├─ invite_ratio	string	非必须
├─ remind_at	string	非必须
├─ rule	string	非必须
├─ activity_rule	string	非必须
├─ ranking_num	string	非必须
├─ title	string	非必须
├─ share_title	string	非必须		分享转发文字
├─ qrcode_title	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

排行

基本信息

Path： /step/api/step/ranking

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
status	是		1好友 2全国

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须		列表	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ ratio	string	必须
├─ step_currency	string	必须
├─ parent_id	string	必须
├─ invite_ratio	string	必须
├─ is_remind	string	必须
├─ is_delete	string	必须
├─ created_at	string	必须
├─ deleted_at	string	必须
├─ nickname	string	必须
├─ avatar	string	必须
├─ user	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ ratio	string	非必须
├─ step_currency	string	非必须
├─ parent_id	string	非必须
├─ invite_ratio	string	非必须
├─ is_remind	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ user	object	非必须		个人信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ store_id	string	非必须
├─ platform	string	非必须
├─ raking	string	非必须		排行
├─ nickname	string	非必须
├─ avatar	string	非必须
├─ ad_data	null	非必须

步数排行

基本信息

Path： /step/api/step/step-convert

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
status	是		1每日 2周

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ step_id	string	必须
├─ ratio	string	必须
├─ real_num	string	必须
├─ num	string	必须
├─ created_at	string	必须
├─ total_num	string	必须		总步数
├─ step	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ ratio	string	非必须
├─ step_currency	string	非必须
├─ parent_id	string	非必须
├─ invite_ratio	string	非必须
├─ is_remind	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ user	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ nickname	string	非必须
├─ auth_key	string	非必须
├─ access_token	string	非必须
├─ mobile	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ userInfo	object	非必须
├─ id	string	非必须
├─ user_id	string	非必须
├─ avatar	string	非必须
├─ platform_user_id	string	非必须
├─ integral	string	非必须
├─ total_integral	string	非必须
├─ balance	string	非必须
├─ parent_id	string	非必须
├─ is_blacklist	string	非必须
├─ contact_way	string	非必须
├─ remark	string	非必须
├─ is_delete	string	非必须
├─ junior_at	string	非必须
├─ store_id	string	非必须
├─ platform	string	非必须
├─ nickname	null	必须		名称
├─ avatar	null	必须		头像

每日兑换

基本信息

Path： /step/api/step/convert

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
num	text	是
code	text	是
encrypted_data	text	是
iv	text	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
list	object	非必须
├─ num	number	非必须
├─ convert	number	非必须		兑换额

活动列表

基本信息

Path： /step/api/step/activity

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
iv	text	是
encrypted_data	text	是
code	text	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
list	object	非必须
├─ activity_data	object []	非必须		详见step-activity	item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ title	string	非必须
├─ currency	string	非必须
├─ step_num	string	非必须
├─ bail_currency	string	非必须
├─ status	string	非必须
├─ type	string	非必须
├─ begin_at	string	非必须
├─ end_at	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ award_num	number	非必须		达标人数
├─ currency_num	number	非必须		奖金数
├─ people_num	number	非必须		参与人数
├─ log	null	非必须
├─ log_status	null	非必须		null未参与 0参与1达标2成功3失败
├─ daily_real_num	number	非必须		当前步数
├─ ad_data	null	非必须		流量主

商品列表

基本信息

Path： /step/api/step/goods

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ name	string	必须
├─ cover_pic	string	必须
├─ id	number	必须
├─ goods_id	number	必须

活动记录

基本信息

Path： /step/api/step/activity-log

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ step_id	string	非必须
├─ activity_id	string	非必须
├─ step_currency	string	非必须
├─ reward_currency	string	非必须
├─ status	string	非必须
├─ created_at	string	非必须
├─ raffled_at	string	非必须
├─ user_num	null	非必须		提交步数
├─ activity	object	非必须		活动信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ title	string	非必须
├─ currency	string	非必须
├─ step_num	string	非必须
├─ bail_currency	string	非必须
├─ status	string	非必须
├─ type	string	非必须
├─ begin_at	string	非必须
├─ end_at	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ info	object	非必须
├─ total_bout	number	非必须		总局数
├─ total_currency	number	非必须		总奖励
├─ bout	number	非必须		赢局数
├─ bout_ratio	number	非必须		比率

活动详情

基本信息

Path： /step/api/step/activity-detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
activity_id	是	1	活动id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须		详见step-activity	item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ title	string	非必须
├─ currency	string	非必须
├─ step_num	string	非必须
├─ bail_currency	string	非必须
├─ status	string	非必须
├─ type	string	非必须
├─ begin_at	string	非必须
├─ end_at	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须

用户提醒

基本信息

Path： /step/api/step/remind

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
is_remind	text	是	1	是否提醒

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

用户记录

基本信息

Path： /step/api/step/log

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ stepUser	object	非必须		用户相关信息
├─ id	number	非必须
├─ mall_id	number	非必须
├─ user_id	number	非必须
├─ ratio	number	非必须
├─ step_currency	string	非必须
├─ parent_id	number	非必须
├─ invite_ratio	number	非必须
├─ is_remind	number	非必须
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ list	object []	非必须		列表	item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ step_id	string	非必须
├─ type	string	非必须		1收入 2 支出
├─ currency	string	非必须
├─ remark	string	非必须		详情
├─ data	string	非必须
├─ created_at	string	非必须

订单提交

基本信息

Path： /step/api/step/order-submit

Method： GET

接口描述：
undefined

请求参数

订单预览

基本信息

Path： /step/api/step/order-preview

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

邀请列表

基本信息

Path： /step/api/step/invite-list

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ ratio	string	必须
├─ step_currency	string	必须
├─ parent_id	string	必须
├─ invite_ratio	string	必须
├─ is_remind	string	必须
├─ is_delete	string	必须
├─ created_at	string	必须
├─ deleted_at	string	必须
├─ nickname	string,null	必须
├─ avatar	string,null	必须
├─ count	number	非必须
├─ now_count	string	非必须		今天邀请数

首页接口

基本信息

Path： /step/api/step/index

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	0DBfMLNTV2H_EqWr1fn7zowiROUfwind	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ user_data	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ ratio	string	非必须
├─ step_currency	string	非必须
├─ parent_id	string	非必须
├─ invite_ratio	string	非必须
├─ is_remind	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ convert_num	string	非必须
├─ old_ratio	string	非必须
├─ daily_invite_num	string	非必须		今天邀请数
├─ invite_list	string []	非必须		邀请列表	item 类型: string
├─		非必须
├─ all_invite	number	非必须		总邀请数
├─ daily_ratio	number	非必须		今天加成数
├─ daily_real_num	number	非必须		今日真实步数 兑换传此参数
├─ daily_num	number	非必须		今日可兑换
├─ activity_data	object	非必须		活动数据详见step-activity
├─ id	string	非必须
├─ mall_id	string	非必须
├─ title	string	非必须
├─ currency	string	非必须
├─ step_num	string	非必须
├─ bail_currency	string	非必须
├─ status	string	非必须
├─ type	string	非必须
├─ begin_at	string	非必须
├─ end_at	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ log	null	非必须
├─ log_status	null	非必须		null 未报名 0报名1达标2成功3失败
├─ people_num	string	非必须		参与人数
├─ total_currency	number	非必须		奖金池
├─ people_reach_num	string	非必须		达标数
├─ ad_data	object	非必须		流量主数据
├─ id	number	非必须
├─ mall_id	number	非必须
├─ unit_id	string	非必须
├─ site	number	非必须
├─ status	number	非必须
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ banner_list	string []	非必须			item 类型: string
├─		非必须

卡券

二维码接口

基本信息

Path： /api/card/card-qrcode

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是
X-App-Platform	wx	是

Query

参数名称	是否必须	示例	备注
cardId	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

卡券核销

基本信息

Path： /card/card-clerk

Method： GET

接口描述：

卡券核销

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
cardId	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

卡券详情

基本信息

Path： /card/user-card-detail

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
cardId	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ card	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ user_id	string	非必须
├─ card_id	string	非必须
├─ name	string	非必须		卡券名称
├─ pic_url	string	非必须		卡券图片
├─ content	string	非必须		卡券内容
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ is_use	string	非必须		是否使用 0--未使用|1--已使用
├─ clerk_id	string	非必须		核销员ID
├─ store_id	string	非必须		核销门店ID
├─ clerked_at	string	非必须		核销时间
├─ order_id	string	非必须
├─ goods_id	string	非必须
├─ data	string	非必须
├─ clerk	null	非必须		核销员信息
├─ store	null	非必须		核销门店信息

我的卡券列表

基本信息

Path： /card/user-card

Method： GET

接口描述：

我的卡券列表

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
page	是
status	是		状态1--未使用 2--已使用 3--已过期

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须
├─ user_id	number	必须
├─ mall_id	number	必须
├─ name	string	必须		卡券名称
├─ pic_url	string	必须		卡券图片
├─ content	string	必须		卡券说明
├─ is_use	number	必须		是否使用 0--未使用|1--已使用

海报

基本信息

Path： /card/give-poster

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
cardId	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ avatar	string	非必须		头像
├─ nickname	string	非必须		昵称
├─ name	string	非必须		卡券名称
├─ pic_url	string	非必须		卡券图片
├─ reset_number	number	非必须		剩余核销次数
├─ start_time	string	非必须		有效期开始时间
├─ end_time	string	非必须		有效期结束时间
├─ qrcode	string	非必须		二维码图片路径

赠送页面

基本信息

Path： /card/give

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
cardId	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ avatar	string	非必须		头像
├─ nickname	string	非必须		昵称
├─ name	string	非必须		卡券名称
├─ pic_url	string	非必须		卡券图片
├─ reset_number	number	非必须		剩余核销次数
├─ is_use	number	非必须		是否可用
├─ start_time	string	非必须		有效期开始时间
├─ end_time	string	非必须		有效期结束时间
├─ status	number	非必须		卡券状态	枚举: 0,1,2,3 枚举备注: 0--卡券失效 1--卡券可领取 2--卡券已领取 3--卡券已被他人领取

领取赠送的卡券

基本信息

Path： /card/receive

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
cardId	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

商品

商品推荐列表

基本信息

Path： /api/goods/new-recommend

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
goods_id	否	1	商品详情页的推荐列表需再传
type	是	goods	可选 goods

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须		商品ID
├─ goods_warehouse_id	number	必须		商品库ID
├─ mch_id	number	必须		商户ID
├─ sign	string	必须		插件标识
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		商品缩略图
├─ original_price	string	必须		商品原价
├─ unit	string	必须		商品单位
├─ page_url	string	必须		页面跳转url
├─ is_negotiable	number	必须		是否面议0.否|1.是
├─ is_level	number	必须		是否显示会员价0.否|1.是
├─ level_price	number	必须		会员价
├─ price	string	必须		商品售价
├─ price_content	string	必须		前端显示的售价
├─ is_sales	string	必须		是否显示销量0.否|1.是
├─ sales	string	必须		销量（包含虚拟销量）
├─ vip_card_appoint	object	必须
├─ discount	null,string	非必须		折扣
├─ is_my_vip_card_goods	number	非必须		登录用户是否享受商品折扣 1是 0否
├─ is_vip_card_user	number	非必须		登录用户是不是会员 1是 0否

商品视频列表

基本信息

Path： /api/goods/goods-list

Method： GET

接口描述：

参数同商品列表

请求参数

Query

参数名称	是否必须	示例	备注
goodsId	是	1	商品id
page	是	1	分页页数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须		商品列表	item 类型: object
├─ id	number	必须		商品id
├─ goods_warehouse_id	number	必须		商品库id
├─ mch_id	number	必须		多商户id
├─ sign	string	必须		商品插件标示
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		商品封面图
├─ original_price	string	必须		商品原价
├─ unit	string	必须		商品单位
├─ page_url	string	必须		商品跳转路径
├─ is_negotiable	number	必须		是否价格面议
├─ is_level	number	必须		是否享受会员价
├─ level_price	number	必须		会员价
├─ price	string	必须		售价
├─ price_content	string	必须		价格文本
├─ is_sales	string	必须		是否显示销量
├─ sales	string	必须		销量文本
├─ attr_groups	object []	必须		规格组	item 类型: object
├─ attr_group_id	number	必须
├─ attr_group_name	string	必须
├─ attr_list	object []	必须			item 类型: object
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ pic_url	string	必须
├─ attr	object []	必须		多规格信息	item 类型: object
├─ id	string	必须
├─ goods_id	number	必须
├─ sign_id	string	必须
├─ stock	string	必须
├─ price	string	必须
├─ no	string	必须
├─ weight	number	必须
├─ pic_url	string	必须
├─ is_delete	number	必须
├─ attr_list	object []	必须			item 类型: object
├─ attr_group_name	string	必须
├─ attr_group_id	number	必须
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ goods_stock	number	必须		商品库存
├─ vip_card_appoint	object	必须		超级会员卡信息
├─ discount	null,string	非必须
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ video_url	string	必须		视频路径
├─ app_share_title	string	必须		自定义分享标题
├─ app_share_pic	string	必须		自定义分享图片

评价列表

基本信息

Path： /api/goods/comments-list

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
goods_id	是
page	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ comments	object []	非必须		评论列表	item 类型: object
├─ content	string	非必须		评论内容
├─ pic_url	string	非必须		评论图片
├─ reply_content	string	非必须		商家回复
├─ avatar	string	非必须		用户头像
├─ time	string	非必须		评论时间
├─ nickname	string	非必须		用户昵称
├─ comment_count	object []	非必须		评论类型	item 类型: object
├─ name	string	必须		类型名称	枚举: 全部,好评,中评,差评
├─ count	string,number	必须		数量
├─ index	number	必须

后台-商城管理

创建商城

基本信息

Path： /admin/mall/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
name	text	是	微商城	商城名称

商城列表

基本信息

Path： /admin/mall/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
keyword	否	商城	商城名称

返回数据

名称	类型	是否必须	默认值	备注	其他信息

商城加入回收站|恢复

基本信息

Path： /admin/mall/update

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	1	商城ID
is_recycle	text	是	1	是否加入回收站0.移出回收站

商城禁用|解禁

基本信息

Path： /admin/mall/disable

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	商城ID
status	是	1	0.禁用

返回数据

名称	类型	是否必须	默认值	备注	其他信息

商城迁移

基本信息

Path： /admin/mall/removal

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
user_id	是	1	迁移至账号的用户ID
mall_id	是	1	被迁移商城ID

回收站删除商城

基本信息

Path： /admin/mall/delete

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	商城ID

版权设置

基本信息

Path： /mall/copyright/setting

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
form[pic_url]	text	是	https://ww3.sinaimg.cn/bmiddle/b5e8f4a9gy1fut2jh80n1j21221von9t.jpg	版权图标
form[description]	text	是	111	版权描述
form[type]	text	是	1	类型1.链接跳转
form[link_url]	text	是	/pages/order/order?status=-1	跳转链接
form[mobile]	text	是	15788888888	电话

砍价

轮播图

基本信息

Path： /bargain/api/index/banner

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW

返回数据

名称	类型	是否必须	默认值	备注	其他信息

商品列表

基本信息

Path： /bargain/api/goods/list

Method： GET

接口描述：

砍价商品列表

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
page	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ name	string	非必须		商品名称
├─ cover_pic	string	非必须		商品图片
├─ price	string	非必须		售价
├─ min_price	string	非必须		最低价
├─ sales	number	非必须		参与人数
├─ goods_id	string	非必须		商品id
├─ status	number	非必须		砍价活动开始或关闭
├─ user_list	object []	非必须			item 类型: object
├─ avatar	string	必须		砍价用户头像
├─ stock	string	非必须		商品库存

商品详情

基本信息

Path： /bargain/api/goods/detail

Method： GET

接口描述：

商品详情

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
goods_id	是	砍价id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ bargain	object	非必须
├─ name	string	非必须		商品名称
├─ pic_url	object []	非必须		商品轮播图	item 类型: object
├─ id	string	必须
├─ pic_url	string	必须
├─ video_url	string	非必须		商品视频
├─ unit	string	非必须		商品单位
├─ price	string	非必须		商品价格
├─ detail	string	非必须		商品详情
├─ goods_id	number	非必须		商品ID
├─ min_price	string	非必须		商品最低价
├─ stock	number	非必须		商品库存
├─ begin_time	string	非必须		砍价开始时间
├─ end_time	string	非必须		砍价结束时间
├─ type	number	非必须		是否允许中途下单 1--允许 2--不允许
├─ time	number	非必须		砍价时间
├─ join_num	number	非必须		参与人数
├─ bargain_info	object	非必须
├─ reset_time	number	非必须		剩余砍价时间
├─ price	number	非必须		商品价格
├─ min_price	number	非必须		商品最低价
├─ now_price	number	非必须		当前价
├─ list	object	非必须
├─ nickname	string	非必须		砍价用户昵称
├─ avatar	string	非必须		砍价用户头像
├─ price	number	非必须		砍价金额
├─ bargain_price	number	非必须		已砍金额
├─ finish_at	string	非必须		砍价结束时间
├─ share	number	非必须		合伙人金额

用户发起砍价订单

基本信息

Path： /bargain/api/order/bargain-submit

Method： GET

接口描述：

用户发起砍价

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
goods_id	是		砍价活动id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
data	object	必须
├─ queueId	string	非必须
├─ token	string	必须

用户发起砍价结果

基本信息

Path： /bargain/api/order/bargain-result

Method： GET

接口描述：

用户发起砍价结果

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Tokem	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
queueId	是
token	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须
data	object	必须
├─ retry	string	必须		重新请求接口
├─ bargain_order_id	string	必须		用户发起砍价的订单ID

用户参与砍价

基本信息

Path： /bargain/api/order/user-join-bargain

Method： GET

接口描述：

用户参与砍价

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
bargain_order_id	是		用户发起砍价结果 接口返回值

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须
data	object	必须
├─ queueId	string	必须
├─ token	string	必须

用户参与砍价结果

基本信息

Path： /bargain/api/order/user-join-bargain-result

Method： GET

接口描述：

用户参与砍价的砍价信息

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
queueId	是		用户参与砍价 接口返回值
token	是		用户参与砍价 接口返回值

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	string	必须
msg	string	必须
data	object	必须
├─ user_id	string	必须		帮砍用户ID
├─ nickname	string	必须		帮砍用户昵称
├─ price	string	必须		帮砍用户砍价金额

活动页面

基本信息

Path： /bargain/api/order/activity

Method： GET

接口描述：

砍价活动页面

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
bargain_order_id	是
page	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ reset_time	number	非必须		剩余时间
├─ price	number	非必须		商品价格
├─ min_price	number	非必须		商品最低价
├─ now_price	number	非必须		当前价
├─ list	object	非必须
├─ nickname	string	非必须		砍价用户昵称
├─ avatar	string	非必须		砍价用户头像
├─ price	number	非必须		砍价金额
├─ bargain_price	number	非必须		已砍金额
├─ goods_name	string	非必须		商品名称
├─ cover_pic	string	非必须		商品封面图
├─ goods_id	number	非必须		商品ID
├─ goods_attr_id	string	非必须		商品规格ID

砍价基础设置

基本信息

Path： /bargain/api/index/index

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

我的砍价

基本信息

Path： /bargain/api/order/bargain-list

Method： GET

接口描述：

我的砍价

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
page	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ goods_name	string	必须		商品名称
├─ cover_pic	string	必须		商品封面图
├─ status	number	必须		砍价状态
├─ status_content	string	必须		砍价状态说明
├─ content	string	必须		砍价说明
├─ reset_time	number	必须		剩余时间（秒）
├─ price	number	必须		商品价格
├─ min_price	number	必须		商品最低价
├─ now_price	number	必须		商品当前价
├─ type	number	必须		是否允许中途购买
├─ finish_at	string	必须		砍价时间（日期格式）
├─ bargain_order_id	string	必须		砍价订单ID
├─ goods_id	string	必须		商品id
├─ goods_attr_id	string	必须		商品规格

积分商城

订单详情

基本信息

Path： /integral_mall/mall/order/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
order_id	是	1

商品放置首页

基本信息

Path： /integral_mall/mall/goods/switch-sell-well

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	134	商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

订单列表

基本信息

Path： /integral_mall/mall/order/index

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Accept	application/json	是

Query

参数名称	是否必须	示例	备注
page	否	1	分页、其它相关参数和商城订单同步

返回数据

名称	类型	是否必须	默认值	备注	其他信息

积分商城设置

基本信息

Path： /integral_mall/mall/setting/index

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
form[desc]	text	是	[[title:标题,content:内容],]	积分说明

返回数据

名称	类型	是否必须	默认值	备注	其他信息

删除优惠券

基本信息

Path： /integral_mall/mall/coupon/destroy

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
id	是	1	优惠券ID

清空回收站

基本信息

Path： /integral_mall/mall/order/destroy-all

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

用户兑换券列表

基本信息

Path： /integral_mall/mall/couponUser/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1

轮播图列表

基本信息

Path： /integral_mall/mall/banner/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1	分页

添加轮播图

基本信息

Path： /integral_mall/mall/banner/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
ids	text	是	[1,2,3]	轮播图ID数组

商品列表

基本信息

Path： /integral_mall/mall/goods/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1	分页
search	否	{keyword:'商品名称'}	搜索条件

添加商品

基本信息

Path： /integral_mall/mall/goods/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
form[integral_num]	text	否	1000	无规格时，兑换所需积分，多规格时需添加多规格积分价

返回数据

名称	类型	是否必须	默认值	备注	其他信息

商品删除

基本信息

Path： /integral_mall/mall/goods/destroy

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	1	商品ID

商品详情

基本信息

Path： /integral_mall/mall/goods/edit

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	30	商品ID

优惠券列表

基本信息

Path： /integral_mall/mall/coupon/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1

添加优惠券

基本信息

Path： /integral_mall/mall/coupon/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	否	1	列表ID
coupon_id	text	否	1	商城优惠券ID
exchange_num	text	是	10	用户可兑换总数
integral_num	text	是	10	多少积分兑换
send_count	text	是	100	优惠券发放总数
price	text	是	10	优惠券价格

返回数据

名称	类型	是否必须	默认值	备注	其他信息

积分商城-插件

分类商品列表

基本信息

Path： /plugin/integral_mall/api/goods/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
cat_id	否	51	分类ID,不填写则返回全部
page	是	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须		商品ID
├─ mall_id	string	必须		商城ID
├─ mch_id	string	必须		商户ID
├─ goods_warehouse_id	string	必须		关联商品库ID
├─ status	string	必须		上架状态：0=下架，1=上架
├─ price	string	必须		售价
├─ use_attr	string	必须		是否使用规格：0=不使用，1=使用
├─ attr_groups	string	必须		商品规格组
├─ goods_stock	string	必须		商品总库存（规格库存相加）
├─ virtual_sales	string	必须		已出售量（虚拟销量）
├─ confine_count	string	必须		购物数量限制
├─ pieces	string	必须		单品满件包邮
├─ forehead	string	必须		单口满额包邮
├─ freight_id	string	必须		运费模板ID
├─ give_integral	string	必须		赠送积分
├─ give_integral_type	string	必须		赠送积分类型1.固定值 |2.百分比
├─ forehead_integral	string	必须		可抵扣积分
├─ forehead_integral_type	string	必须		可抵扣积分类型1.固定值 |2.百分比
├─ accumulative	string	必须		允许多件累计折扣
├─ individual_share	string	必须		是否单独合伙人设置：0=否，1=是
├─ attr_setting_type	string	必须		合伙人设置类型 0.普通设置|1.详细设置
├─ is_level	string	必须		是否享受会员价购买
├─ is_level_alone	string	必须		是否单独设置会员价
├─ share_type	string	必须		合伙人佣金配比 0--固定金额 1--百分比
├─ sign	string	必须		商品标示用于区分商品属于什么模块
├─ app_share_pic	string	必须		商品自定义分享图片
├─ app_share_title	string	必须		商品自定义分享标题
├─ is_default_services	string	必须		默认服务 0.否|1.是
├─ sort	string	必须		商品排序
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ payment_people	string	必须		统计 支付人数
├─ payment_num	string	必须		统计 支付件数
├─ payment_amount	string	必须		统计 支付金额
├─ payment_order	string	必须		支付订单数
├─ confine_order_count	string	必须		限制下单数量
├─ is_area_limit	string	必须		是否单独区域购买
├─ area_limit	string	必须		区域限制详情 json格式
├─ share_level_type	string	必须		合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_id	string	必须		自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ goodsWarehouse	object	必须
├─ id	string	非必须		商品库商品ID
├─ mall_id	string	非必须		商城ID
├─ name	string	非必须		商品名称
├─ original_price	string	非必须		商品原价
├─ cost_price	string	非必须		成本价
├─ detail	string	非必须		商品详情json
├─ cover_pic	string	非必须		商品缩略图
├─ pic_url	string	非必须		商品轮播图
├─ video_url	string	非必须		商品视频
├─ unit	string	非必须		商品单位
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ attr	object []	必须			item 类型: object
├─ id	string	必须
├─ goods_id	string	必须
├─ sign_id	string	必须
├─ stock	string	必须
├─ price	string	必须
├─ no	string	必须
├─ weight	string	必须
├─ pic_url	string	必须
├─ is_delete	string	必须
├─ integral_num	string	必须
├─ integralMallGoods	object	必须
├─ id	string	非必须
├─ goods_id	string	非必须		商品ID
├─ mall_id	string	非必须		商城ID
├─ is_home	string	非必须		是否放置首页0.否|1.是
├─ integral_num	string	非必须		商品所需积分
├─ is_delete	string	非必须
├─ cover_pic	string	必须		商品缩略图
├─ name	string	必须		商品名称
├─ original_price	string	必须		商品原价
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

优惠券兑换列表

基本信息

Path： /plugin/integral_mall/api/coupon-order/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1	分页

返回数据

名称	类型	是否必须	默认值	备注	其他信息
	object []	非必须			item 类型: object
├─ id	string	必须		兑换记录ID
├─ user_id	string	必须		用户ID
├─ mall_id	string	必须		商城ID
├─ order_no	string	必须		订单号
├─ integral_mall_coupon_id	string	必须		积分优惠券ID
├─ integral_mall_coupon_info	string	必须		购买的优惠券信息
├─ user_coupon_id	string	必须		用户优惠券ID
├─ price	string	必须		价格
├─ integral_num	string	必须		兑换所需积分
├─ is_pay	string	必须		订单是否支付
├─ pay_time	string	必须		支付时间
├─ pay_type	string	必须		订单支付类型
├─ token	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ integralCoupon	object	必须		优惠券信息
├─ id	string	非必须		积分商城优惠券ID
├─ mall_id	string	非必须		商城ID
├─ coupon_id	string	非必须		优惠券ID
├─ exchange_num	string	非必须		兑换次数限制
├─ integral_num	string	非必须		兑换所需积分
├─ send_count	string	非必须		发放总数
├─ price	string	非必须		价格
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ coupon	object	非必须		优惠券基本信息
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须		优惠券名称
├─ type	string	非必须		优惠券类型：1=折扣，2=满减
├─ discount	string	非必须		折扣率
├─ pic_url	string	非必须
├─ desc	string	非必须
├─ min_price	string	非必须		最低消费金额
├─ sub_price	string	非必须		优惠金额
├─ total_count	string	非必须		发放总数量
├─ sort	string	非必须		排序按升序排列
├─ expire_type	string	非必须		到期类型：1=领取后N天过期，2=指定有效期
├─ expire_day	string	非必须		有效天数，expire_type=1时
├─ begin_time	string	非必须		有效期开始时间
├─ end_time	string	非必须		有效期结束时间
├─ appoint_type	string	非必须		1 指定分类 2 指定商品 3全部
├─ rule	string	非必须		使用说明
├─ is_member	string	非必须		是否指定会员等级
├─ is_delete	string	非必须
├─ deleted_at	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

优惠券列表

基本信息

Path： /plugin/integral_mall/api/coupon/index

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须		列表ID
├─ mall_id	string	必须		商城ID
├─ coupon_id	string	必须		优惠券ID
├─ exchange_num	string	必须		兑换次数-1.不限制
├─ integral_num	string	必须		所需兑换积分
├─ send_count	string	必须		发放优惠券总数
├─ price	string	必须		优惠券价格
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ coupon	object	必须
├─ id	string	非必须		优惠券ID
├─ mall_id	string	非必须		优惠券所属商城ID
├─ name	string	非必须		优惠券名称
├─ type	string	非必须		优惠券类型：1=折扣（暂时无用），2=满减
├─ discount	string	非必须		折扣率
├─ pic_url	string	非必须		图片
├─ desc	string	非必须		描述
├─ min_price	string	非必须		最低消费金额
├─ sub_price	string	非必须		抵扣金额
├─ total_count	string	非必须		发放总数量
├─ is_join	string	非必须		是否加入领券中心 1--不加入领券中心 2--加入领券中心
├─ sort	string	非必须		排序按升序排列
├─ expire_type	string	非必须		到期类型：1=领取后N天过期，2=指定有效期
├─ expire_day	string	非必须		有效天数，expire_type=1时
├─ begin_time	string	非必须		有效期开始时间
├─ end_time	string	非必须		有效期结束时间
├─ appoint_type	string	非必须		1 指定分类 2 指定商品 3--全场通用
├─ rule	string	非必须		使用说明
├─ is_delete	string	非必须		删除
├─ receive_count	string	非必须		领取的数量
├─ couponCat	object []	非必须			item 类型: object
├─ id	string	必须
├─ coupon_id	string	必须		优惠券ID
├─ cat_id	string	必须		分类ID
├─ is_delete	string	必须
├─ couponGoods	string []	非必须			item 类型: string
├─		非必须
├─ couponOrders	string []	必须			item 类型: string
├─		非必须
├─ is_receive	number	必须		是否已领取0.否|1.是
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

优惠券订单提交

基本信息

Path： /plugin/integral_mall/api/coupon-order/order-submit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW

Query

参数名称	是否必须	示例	备注
X-Access-Token	是	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	1	优惠券ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

优惠券订单支付

基本信息

Path： /plugin/integral_mall/api/coupon-order/order-pay-data

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
queue_id	是		订单队列ID
token	是		订单token

优惠券详情

基本信息

Path： /plugin/integral_mall/api/coupon/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	积分商城优惠券ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ coupon	object	非必须
├─ id	string	非必须		优惠券ID
├─ mall_id	string	非必须		所属商城ID
├─ name	string	非必须		优惠券名称
├─ type	string	非必须		优惠券类型：1=折扣（暂时无用），2=满减
├─ discount	string	非必须		折扣率
├─ pic_url	string	非必须
├─ desc	string	非必须
├─ min_price	string	非必须		最低消费金额
├─ sub_price	string	非必须		抵扣金额
├─ total_count	string	非必须		发放总数量
├─ is_join	string	非必须		是否加入领券中心 1--不加入领券中心 2--加入领券中心
├─ sort	string	非必须		排序按升序排列
├─ expire_type	string	非必须		到期类型：1=领取后N天过期，2=指定有效期
├─ expire_day	string	非必须		有效天数，expire_type=1时
├─ begin_time	string	非必须		有效期开始时间
├─ end_time	string	非必须		有效期结束时间
├─ appoint_type	string	非必须		1 指定分类 2 指定商品 3--全场通用
├─ rule	string	非必须		使用说明
├─ is_delete	string	非必须		删除
├─ cat	object []	非必须		优惠券所属分类（appoint_type==1）	item 类型: object
├─ name	string	必须		分类名称
├─ goods	object []	非必须		优惠券所属商品（appoint_type==2）	item 类型: object
├─ name	string	必须		商品名称
├─ is_receive	integer	非必须		领取的数量

兑换商品详情

基本信息

Path： /integral_mall/api/order/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	number	非必须		订单ID
├─ mall_id	number	非必须		商城ID
├─ user_id	number	非必须		用户ID
├─ mch_id	number	非必须		商户ID
├─ order_no	string	非必须		订单号
├─ total_price	string	非必须		订单总金额(含运费)
├─ total_pay_price	string	非必须		实际支付总费用(含运费）
├─ express_original_price	string	非必须		运费(后台修改前)
├─ express_price	string	非必须		运费(后台修改后)
├─ total_goods_price	string	非必须		订单商品总金额(优惠后)
├─ total_goods_original_price	string	非必须		订单商品总金额(优惠前)
├─ member_discount_price	string	非必须		会员优惠价格(正数表示优惠，负数表示加价)
├─ use_user_coupon_id	number	非必须		使用的用户优惠券id
├─ coupon_discount_price	string	非必须		优惠券优惠金额
├─ use_integral_num	number	非必须		使用积分数量
├─ integral_deduction_price	string	非必须		积分抵扣金额
├─ name	string	非必须		收件人姓名
├─ mobile	string	非必须		收件人手机号
├─ address	string	非必须		收件人地址
├─ remark	string	非必须		用户订单备注
├─ order_form	object []	非必须		自定义表单（JSON）	item 类型: object
├─ key	string	必须		表单组件唯一标识
├─ label	string	必须		表单名称
├─ value	string,null	必须		表单值
├─ required	number	必须		表单组件是否必填
├─ words	string	非必须		商家留言
├─ seller_remark	string	非必须		商家订单备注
├─ is_pay	number	非必须		是否支付：0.未支付|1.已支付
├─ pay_type	number	非必须		支付方式：1.在线支付 2.货到付款 3.余额支付
├─ pay_time	string	非必须		支付时间
├─ is_send	number	非必须		是否发货：0.未发货|1.已发货
├─ send_time	string	非必须		发货时间
├─ customer_name	string	非必须		(已废弃)京东商家编号
├─ express	string	非必须		(已废弃)物流公司
├─ express_no	string	非必须		(已废弃)物流订单号
├─ is_sale	number	非必须		是否过售后时间
├─ is_confirm	number	非必须		收货状态：0.未收货|1.已收货
├─ confirm_time	string	非必须		确认收货时间
├─ cancel_status	number	非必须		订单取消状态：0.未取消|1.已取消|2.申请取消
├─ cancel_time	string	非必须		订单取消时间
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ is_recycle	number	非必须		是否加入回收站 0.否|1.是
├─ send_type	number	非必须		是否到店自提：0.否|1.是
├─ offline_qrcode	string	非必须		核销码
├─ clerk_id	number	非必须		核销员ID
├─ store_id	number	非必须		自提门店ID
├─ sign	string	非必须		订单标识，用于区分插件
├─ token	string	非必须		订单所属队列标识
├─ support_pay_types	string	非必须		支持的支付方式，空表示支持系统设置支持的所有方式
├─ is_comment	number	非必须		是否评价0.否|1.是
├─ comment_time	string	非必须		评价时间
├─ sale_status	number	非必须		是否申请售后0.否|1.是
├─ status	number	非必须		订单状态|1.已完成|0.进行中不能对订单进行任何操作
├─ back_price	string	非必须		后台优惠(正数表示优惠，负数表示加价)
├─ auto_cancel_time	string	非必须		自动取消时间
├─ auto_confirm_time	null,string	非必须		自动确认收货时间
├─ auto_sales_time	null,string	非必须		自动售后时间
├─ distance	number	非必须		同城配送距离，-1不在范围内，正数为距离KM
├─ city_mobile	string	非必须		同城配送联系方式
├─ location	null	非必须		同城配送用户经纬度
├─ city_name	null	非必须		城市名称
├─ city_info	null	非必须		城市信息
├─ detail	object []	非必须			item 类型: object
├─ id	number	非必须		商品详情ID
├─ order_id	number	非必须		关联订单ID
├─ goods_id	number	非必须		商品ID
├─ num	number	非必须		商品数量
├─ unit_price	string	非必须		商品单价
├─ total_original_price	string	非必须		商品原总价(优惠前)
├─ total_price	string	非必须		商品总价(优惠后)
├─ member_discount_price	string	非必须		会员优惠金额(正数表示优惠，负数表示加价)
├─ goods_info	object	非必须		商品信息josn格式
├─ name	string	非必须		商品名称
├─ attr_list	object []	非必须		已选规格信息	item 类型: object
├─ attr_group_name	string	必须		规格组名
├─ attr_group_id	number	必须		规格组ID
├─ attr_id	number	必须		规格ID
├─ attr_name	string	必须		规格名称
├─ pic_url	string	非必须		商品缩略图
├─ num	number	非必须		商品数量
├─ total_original_price	string	非必须		商品总价（优惠前）
├─ member_discount_price	string	非必须		会员折扣金额
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_refund	number	非必须		商品是否退款
├─ refund_status	number	非必须		售后状态 0--未售后 1--售后中 2--售后结束
├─ back_price	string	非必须		售后状态 0--未售后 1--售后中 2--售后结束
├─ sign	string	非必须		订单详情标识，用于区分插件
├─ goods_no	string	非必须		商品货号
├─ integralOrder	object	非必须
├─ id	string	非必须		积分商城订单ID
├─ mall_id	string	非必须		商城ID
├─ order_id	string	非必须		关联订单ID
├─ token	string	非必须		关联订单token
├─ integral_num	string	非必须		积分金额
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须

优惠券兑换详情

基本信息

Path： /plugin/integral_mall/api/coupon-order/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	订单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息

商品兑换列表

基本信息

Path： /integral_mall/api/order/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须		订单ID
├─ mall_id	number	必须		商城ID
├─ user_id	number	必须		用户ID
├─ mch_id	number	必须		商户ID
├─ order_no	string	必须		订单号
├─ total_price	string	必须		订单总金额(含运费)
├─ total_pay_price	string	必须		实际支付总费用(含运费）
├─ express_original_price	string	必须		运费(后台修改前)
├─ express_price	string	必须		运费(后台修改后)
├─ total_goods_price	string	必须		订单商品总金额(优惠后)
├─ total_goods_original_price	string	必须		订单商品总金额(优惠前)
├─ member_discount_price	string	必须		会员优惠价格(正数表示优惠，负数表示加价)
├─ use_user_coupon_id	number	必须		使用的用户优惠券id
├─ coupon_discount_price	string	必须		优惠券优惠金额
├─ use_integral_num	number	必须		使用积分数量
├─ integral_deduction_price	string	必须		积分抵扣金额
├─ name	string	必须		收件人姓名
├─ mobile	string	必须		收件人手机号
├─ address	string	必须		收件人地址
├─ remark	string	必须		用户订单备注
├─ order_form	object []	必须		自定义表单（JSON）	item 类型: object
├─ key	string	必须		表单组件唯一标识
├─ label	string	必须		表单名称
├─ value	string,null	必须		表单值
├─ required	number	必须		表单组件是否必填
├─ words	string	必须		商家留言
├─ seller_remark	string	必须		商家订单备注
├─ is_pay	number	必须		是否支付：0.未支付|1.已支付
├─ pay_type	number	必须		支付方式：1.在线支付 2.货到付款 3.余额支付
├─ pay_time	string	必须		支付时间
├─ is_send	number	必须		是否发货：0.未发货|1.已发货
├─ send_time	string	必须		发货时间
├─ customer_name	string	必须		(已废弃)京东商家编号
├─ express	string	必须		(已废弃)物流公司
├─ express_no	string	必须		(已废弃)物流订单号
├─ is_sale	number	必须		是否过售后时间
├─ is_confirm	number	必须		收货状态：0.未收货|1.已收货
├─ confirm_time	string	必须		确认收货时间
├─ cancel_status	number	必须		订单取消状态：0.未取消|1.已取消|2.申请取消
├─ cancel_time	string	必须		订单取消时间
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	number	必须
├─ is_recycle	number	必须		是否加入回收站 0.否|1.是
├─ send_type	number	必须		是否到店自提：0.否|1.是
├─ offline_qrcode	string	必须		核销码
├─ clerk_id	number	必须		核销员ID
├─ store_id	number	必须		自提门店ID
├─ sign	string	必须		订单标识，用于区分插件
├─ token	string	必须		订单所属队列标识
├─ support_pay_types	string	必须		支持的支付方式，空表示支持系统设置支持的所有方式
├─ is_comment	number	必须		是否评价0.否|1.是
├─ comment_time	string	必须		评价时间
├─ sale_status	number	必须		是否申请售后0.否|1.是
├─ status	number	必须		订单状态|1.已完成|0.进行中不能对订单进行任何操作
├─ back_price	string	必须		后台优惠(正数表示优惠，负数表示加价)
├─ auto_cancel_time	string	必须		自动取消时间
├─ auto_confirm_time	null,string	必须		自动确认收货时间
├─ auto_sales_time	null,string	必须		自动售后时间
├─ distance	number	必须		同城配送距离，-1不在范围内，正数为距离KM
├─ city_mobile	string	必须		同城配送联系方式
├─ location	null	必须		同城配送用户经纬度
├─ city_name	null	必须		城市名称
├─ city_info	null	必须		城市信息
├─ detail	object []	必须			item 类型: object
├─ id	string	必须
├─ order_id	string	必须
├─ goods_id	string	必须
├─ num	string	必须
├─ unit_price	string	必须
├─ total_original_price	string	必须
├─ total_price	string	必须
├─ member_discount_price	string	必须
├─ goods_info	object	必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	必须
├─ attr_group_id	number	必须
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ goods_attr	object	非必须
├─ id	number	非必须
├─ goods_id	number	非必须
├─ sign_id	string	非必须
├─ stock	number	非必须
├─ price	string	非必须
├─ original_price	string	非必须
├─ no	string	非必须
├─ weight	number	非必须
├─ pic_url	string	非必须
├─ share_commission_first	string	非必须
├─ share_commission_second	string	非必须
├─ share_commission_third	string	非必须
├─ individual_share	number	非必须
├─ share_type	number	非必须
├─ member_price	null	非必须
├─ integral_price	null	非必须
├─ use_integral	null	非必须
├─ discount	string []	非必须			item 类型: string
├─		非必须
├─ extra	object	非必须
├─ integral_num	number	非必须
├─ goods_warehouse_id	number	非必须
├─ name	string	非必须
├─ cover_pic	string	非必须
├─ detail	string	非必须
├─ pic_list	string	非必须
├─ number	number	非必须
├─ name	string	非必须
├─ is_delete	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_refund	string	必须
├─ refund_status	string	必须
├─ back_price	string	必须
├─ sign	string	必须
├─ goods_no	string	必须
├─ goods	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ mch_id	string	非必须
├─ goods_warehouse_id	string	非必须
├─ status	string	非必须
├─ price	string	非必须
├─ use_attr	string	非必须
├─ attr_groups	string	非必须
├─ goods_stock	string	非必须
├─ virtual_sales	string	非必须
├─ confine_count	string	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ freight_id	string	非必须
├─ give_integral	string	非必须
├─ give_integral_type	string	非必须
├─ forehead_integral	string	非必须
├─ forehead_integral_type	string	非必须
├─ accumulative	string	非必须
├─ individual_share	string	非必须
├─ attr_setting_type	string	非必须
├─ is_level	string	非必须
├─ is_level_alone	string	非必须
├─ share_type	string	非必须
├─ sign	string	非必须
├─ app_share_pic	string	非必须
├─ app_share_title	string	非必须
├─ is_default_services	string	非必须
├─ sort	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须
├─ payment_num	string	非必须
├─ payment_amount	string	非必须
├─ payment_order	string	非必须
├─ confine_order_count	string	非必须
├─ is_area_limit	string	非必须
├─ area_limit	string	非必须
├─ share_level_type	string	非必须
├─ form_id	string	非必须
├─ goodsWarehouse	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ original_price	string	非必须
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ cover_pic	string	非必须
├─ pic_url	string	非必须
├─ video_url	string	非必须
├─ unit	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ integralOrder	object	必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ order_id	string	非必须		订单ID
├─ token	string	非必须		订单token
├─ integral_num	string	非必须		商品所需积分
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ deleted_at	string	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

商品分类列表

基本信息

Path： /plugin/integral_mall/api/goods/cats

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须		分类ID
├─ mall_id	string	必须		商城ID
├─ mch_id	string	必须		商户ID
├─ parent_id	string	必须		父级ID
├─ name	string	必须		分类名称
├─ pic_url	string	必须		分类图片
├─ sort	string	必须		排序，升序
├─ big_pic_url	string	必须		分类大图
├─ advert_pic	string	必须		广告大图 用于分类广告
├─ advert_url	string	必须		广告跳转rul
├─ status	string	必须		是否启用:0.禁用|1.启用
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_show	string	必须		分类是否显示0.否|1.是

商品详情

基本信息

Path： /plugin/integral_mall/api/goods/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	61	商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	string	非必须		商品ID
├─ mall_id	string	非必须		商城ID
├─ mch_id	string	非必须		商户ID
├─ goods_warehouse_id	string	非必须		关联商品库ID
├─ status	string	非必须		上架状态：0=下架，1=上架
├─ price	string	非必须		售价
├─ use_attr	string	非必须		是否使用规格：0=不使用，1=使用
├─ attr_groups	string	非必须		商品规格组
├─ goods_stock	string	非必须		商品总库存（规格库存相加）
├─ virtual_sales	string	非必须		已出售量（虚拟销量）
├─ confine_count	string	非必须		购物数量限制
├─ pieces	string	非必须		单品满件包邮
├─ forehead	string	非必须		单口满额包邮
├─ freight_id	string	非必须		运费模板ID
├─ give_integral	string	非必须		赠送积分
├─ give_integral_type	string	非必须		赠送积分类型1.固定值 |2.百分比
├─ forehead_integral	string	非必须		可抵扣积分
├─ forehead_integral_type	string	非必须		可抵扣积分类型1.固定值 |2.百分比
├─ accumulative	string	非必须		允许多件累计折扣
├─ individual_share	string	非必须		是否单独合伙人设置：0=否，1=是
├─ attr_setting_type	string	非必须		合伙人设置类型 0.普通设置|1.详细设置
├─ is_level	string	非必须		是否享受会员价购买
├─ is_level_alone	string	非必须		是否单独设置会员价
├─ share_type	string	非必须		合伙人佣金配比 0--固定金额 1--百分比
├─ sign	string	非必须		商品标示用于区分商品属于什么模块
├─ app_share_pic	string	非必须		商品自定义分享图片
├─ app_share_title	string	非必须		商品自定义分享标题
├─ is_default_services	string	非必须		默认服务 0.否|1.是
├─ sort	string	非必须		商品排序
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ payment_people	string	非必须		统计 支付人数
├─ payment_num	string	非必须		统计 支付件数
├─ payment_amount	string	非必须		统计 支付金额
├─ payment_order	string	非必须		支付订单数
├─ confine_order_count	string	非必须		限制下单数量
├─ is_area_limit	string	非必须		是否单独区域购买
├─ area_limit	string	非必须		区域限制详情 json格式
├─ share_level_type	string	非必须		合伙人等级佣金配比 0--固定金额 1--百分比
├─ form_id	string	非必须		自定义表单id 0--表示默认表单 -1--表示不使用表单
├─ name	string	非必须		商品名称
├─ original_price	string	非必须		商品原价
├─ cover_pic	string	非必须		商品缩略图
├─ unit	string	非必须		商品单位
├─ detail	string	非必须		商品详情
├─ video_url	string	非必须		商品视频url
├─ level_show	number	非必须		显示会员价0.不显示|1.是当前用户会员价|2.下一级会员价
├─ is_sales	number	非必须		是否显示销量0.否|1.是
├─ attr	object []	非必须			item 类型: object
├─ id	number	非必须
├─ goods_id	number	非必须
├─ sign_id	string	非必须
├─ stock	number	非必须
├─ price	string	非必须
├─ no	string	非必须
├─ weight	number	非必须
├─ pic_url	string	非必须
├─ is_delete	number	非必须
├─ attr_list	object []	非必须			item 类型: object
├─ attr_group_name	string	非必须
├─ attr_group_id	number	非必须
├─ attr_id	number	非必须
├─ attr_name	string	非必须
├─ price_member	number	非必须
├─ member_price_list	object []	非必须			item 类型: object
├─ id	number	非必须
├─ level	number	非必须
├─ price	string	非必须
├─ goods_attr_id	number	非必须
├─ is_delete	number	非必须
├─ goods_id	number	非必须
├─ integral_num	string	非必须
├─ extra	object	非必须
├─ value	string	非必须
├─ name	string	非必须
├─ goods_num	number	非必须		商品库存
├─ goods_no	string	非必须		商品货号
├─ goods_weight	number	非必须		商品重量
├─ services	string []	非必须		商品服务	item 类型: string
├─		非必须
├─ cards	string []	非必须			item 类型: string
├─		非必须
├─ price_min	number	非必须		商品规格最小价
├─ price_max	number	非必须		商品规格最大价
├─ pic_url	object []	非必须		商品轮播图	item 类型: object
├─ id	string	非必须
├─ pic_url	string	非必须
├─ share	number	非必须		合伙人金额
├─ sales	number	非必须		销量
├─ favorite	boolean	非必须
├─ goods_marketing	object	非必须
├─ limit	string	非必须
├─ pickup	string	非必须
├─ shipping	string	非必须
├─ goods_marketing_award	object	非必须
├─ card	object	非必须
├─ title	string	非必须
├─ list	string []	非必须			item 类型: string
├─		非必须
├─ integral	object	非必须
├─ title	string	非必须
├─ vip_card_appoint	object	非必须
├─ discount	null	非必须		折扣
├─ is_my_vip_card_goods	number	非必须		登录用户是否享受商品折扣 1是 0否
├─ is_vip_card_user	number	非必须		登录用户是不是会员 1是 0否
├─ integralMallGoods	object	非必须
├─ id	number	非必须		积分商城商品ID
├─ goods_id	number	非必须		商品ID
├─ mall_id	number	非必须		商城ID
├─ is_home	number	非必须		是否放置首页0.否|1.是
├─ integral_num	number	非必须		商品所属积分
├─ is_delete	number	非必须

积分商城首页

基本信息

Path： /plugin/integral_mall/api/index/index

Method： GET

接口描述：

跳转方式参数说明
app跳转
    app_id    跳转小程序的appID
    path    跳转的小程序页面

tel 跳转
    tel    联系电话

web 跳转
    url    跳转网页路径

contact 跳转

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ banners	object []	非必须		轮播图列表	item 类型: object
├─ id	string	必须		轮播图ID
├─ mall_id	string	必须		商城ID
├─ pic_url	string	必须		图片
├─ title	string	必须		标题
├─ page_url	string	必须		跳转页面url
├─ open_type	string	必须		打开方式:redirect 重定向跳转|navigate普通跳转|app 跳转小程序|contact 客服| clear_cache 清除缓存| tel 拔打电话|web 跳转网页
├─ params	string	必须		导航参数
├─ is_delete	string	必须
├─ created_at	string	必须
├─ deleted_at	string	必须
├─ updated_at	string	必须
├─ setting	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ is_share	number	非必须
├─ is_sms	number	非必须
├─ is_mail	number	非必须
├─ is_print	number	非必须
├─ is_territorial_limitation	number	非必须
├─ desc	object []	非必须			item 类型: object
├─ title	string	必须
├─ content	string	必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ payment_type	string []	非必须			item 类型: string
├─		非必须
├─ send_type	string []	非必须			item 类型: string
├─		非必须
├─ goods_poster	object	非必须
├─ bg_pic	object	非必须
├─ url	string	非必须
├─ pic	object	非必须
├─ is_show	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_type	string	非必须
├─ head	object	非必须
├─ is_show	number	非必须
├─ size	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_type	string	非必须
├─ nickname	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ nickname_share	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ poster_bg	object	非必须
├─ is_show	number	非必须
├─ width	number	非必须
├─ height	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ file_path	string	非必须
├─ file_type	string	非必须
├─ qr_code	object	非必须
├─ is_show	number	非必须
├─ size	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ type	number	非必须
├─ file_path	string	非必须
├─ file_type	string	非必须
├─ name	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ desc	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ text	string	非必须
├─ color	string	非必须
├─ file_type	string	非必须
├─ width	number	非必须
├─ price	object	非必须
├─ is_show	number	非必须
├─ font	number	非必须
├─ top	number	非必须
├─ left	number	非必须
├─ color	string	非必须
├─ text	string	非必须
├─ file_type	string	非必须
├─ userInfo	object	非必须
├─ integral	number	非必须

积分明细列表

基本信息

Path： /api/integral-log/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1
type	是	1	类型 1.收入(默认)

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须		积分明细ID
├─ mall_id	string	必须		商城ID
├─ user_id	string	必须		用户ID
├─ type	string	必须		类型：1=收入，2=支出
├─ integral	string	必须		变动积分
├─ desc	string	必须		变动说明
├─ custom_desc	string	必须		自定义详细说明|记录
├─ created_at	string	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

订单提交

基本信息

Path： /plugin/integral_mall/api/order/order-submit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

订单预览

基本信息

Path： /plugin/integral_mall/api/order/order-preview

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

coupon

优惠券列表

基本信息

Path： /coupon/list

Method： GET

接口描述：

加入领券中心的优惠券列表

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token		是	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	token

Query

参数名称	是否必须	示例	备注
page	否	1	分页数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须		0
msg	string	非必须
data	object	非必须
├─ list	object []	非必须		优惠券列表	item 类型: object
├─ id	string	必须		优惠券ID
├─ mall_id	string	必须		所属商城ID
├─ name	string	必须		优惠券名称
├─ type	string	必须		优惠券类型：1=折扣（暂时无用），2=满减
├─ discount	string	必须		折扣率
├─ pic_url	string	必须
├─ desc	string	必须
├─ min_price	string	必须		最低消费金额
├─ sub_price	string	必须		抵扣金额
├─ total_count	string	必须		发放总数量
├─ is_join	string	必须		是否加入领券中心 1--不加入领券中心 2--加入领券中心
├─ sort	string	必须		排序按升序排列
├─ expire_type	string	必须		到期类型：1=领取后N天过期，2=指定有效期
├─ expire_day	string	必须		有效天数，expire_type=1时
├─ begin_time	string	必须		有效期开始时间
├─ end_time	string	必须		有效期结束时间
├─ appoint_type	string	必须		1 指定分类 2 指定商品 3--全场通用
├─ rule	string	必须		使用说明
├─ is_delete	string	必须		删除
├─ cat	object []	非必须		优惠券所属分类（appoint_type==1）	item 类型: object
├─ name	string	必须		分类名称
├─ goods	object []	非必须		优惠券所属商品（appoint_type==2）	item 类型: object
├─ name	string	必须		商品名称
├─ is_receive	integer	必须		领取的数量

优惠券海报

基本信息

Path： /coupon/give-poster

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
user_coupon_id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ id	number	非必须		优惠券id
├─ name	string	非必须		优惠券名称
├─ type	number	非必须		优惠券类型
├─ discount	string	非必须		优惠券折扣
├─ discount_limit	null	非必须		优惠上限
├─ min_price	string	非必须		门槛
├─ sub_price	string	非必须		满减金额
├─ expire_type	number	非必须		到期类型：1=领取后N天过期，2=指定有效期
├─ expire_day	number	非必须		有效天数，expire_type=1时
├─ begin_time	string	非必须		有效期开始时间
├─ end_time	string	非必须		有效期结束时间
├─ appoint_type	string	非必须		类型
├─ avatar	string	非必须		头像
├─ nickname	string	非必须		昵称
├─ qrcode	string	非必须		二维码

优惠券详情

基本信息

Path： /coupon/detail

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	token

Query

参数名称	是否必须	示例	备注
coupon_id	是	1	优惠券ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object	非必须
├─ id	string	非必须		优惠券ID
├─ mall_id	string	非必须		优惠券所属商城ID
├─ name	string	非必须		优惠券名称
├─ type	string	非必须		优惠券类型：1=折扣（暂时无用），2=满减
├─ discount	string	非必须		折扣率
├─ pic_url	string	非必须
├─ desc	string	非必须
├─ min_price	string	非必须		最低消费金额
├─ sub_price	string	非必须		抵扣金额
├─ total_count	string	非必须		发放总数量
├─ is_join	string	非必须		是否加入领券中心 1--不加入领券中心 2--加入领券中心
├─ sort	string	非必须		排序按升序排列
├─ expire_type	string	非必须		到期类型：1=领取后N天过期，2=指定有效期
├─ expire_day	string	非必须		有效天数，expire_type=1时
├─ begin_time	string	非必须		有效期开始时间
├─ end_time	string	非必须		有效期结束时间
├─ appoint_type	string	非必须		1 指定分类 2 指定商品 3--全场通用
├─ rule	string	非必须		使用说明
├─ is_delete	string	非必须		删除
├─ receive_count	string	非必须		领取的数量
├─ cat	object []	非必须		优惠券所属分类（appoint_type==1）	item 类型: object
├─ name	string	非必须		分类名称
├─ goods	object []	非必须		优惠券所属商品（appoint_type==2）	item 类型: object
├─ name	string	非必须		商品名称

优惠券领取

基本信息

Path： /coupon/receive

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW

Query

参数名称	是否必须	示例	备注
coupon_id	是	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须		0--成功 1--失败
msg	string	非必须

分享获得优惠券

基本信息

Path： /coupon/share-coupon

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

我的优惠券

基本信息

Path： /coupon/user-coupon

Method： GET

接口描述：

我的优惠券列表

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
status	是	1、2、3	状态 1--未使用 2--已使用 3--已过期

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须		用户优惠券ID
├─ mall_id	string	必须		商城ID
├─ user_id	string	必须		用户ID
├─ coupon_id	string	必须		优惠券ID
├─ coupon_min_price	string	必须		最低消费金额
├─ start_time	string	必须		开始时间
├─ end_time	string	必须		结束时间
├─ is_use	string	必须		是否使用 0--未使用 1--已使用
├─ is_delete	string	必须		是否删除 0--未删除 1--已删除
├─ created_at	string	必须		创建时间
├─ updated_at	string	必须		更新时间
├─ deleted_at	string	必须		删除时间
├─ receive_type	string	必须		获取方式
├─ coupon_data	string	必须		优惠券信息
├─ coupon	object	必须		优惠券详情
├─ id	string	非必须		优惠券ID
├─ mall_id	string	非必须
├─ name	string	非必须		优惠券名称
├─ type	string	非必须		优惠券类型：1=折扣，2=满减
├─ discount	string	非必须		折扣率
├─ sub_price	string	非必须		优惠金额
├─ pic_url	string	非必须
├─ desc	string	非必须
├─ total_count	string	非必须		发放总数量
├─ is_join	string	非必须		是否加入领券中心 1--不加入领券中心 2--加入领券中心
├─ appoint_type	string	非必须		1 指定商品 2 指定商品 3全部
├─ rule	string	非必须		优惠券使用说明
├─ cat	object []	非必须		优惠券指定分类	item 类型: object
├─ name	string	必须		分类名称
├─ goods	object []	非必须			item 类型: object
├─ name	string	必须		商品名称

我的优惠券详情

基本信息

Path： /coupon/user-coupon-detail

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
user_coupon_id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object	非必须
├─ sub_price	string	非必须		优惠金额
├─ discount	string	非必须		优惠折扣
├─ coupon_min_price	string	非必须		最低消费金额
├─ type	number	非必须		优惠券类型：1=折扣，2=满减
├─ start_time	string	非必须		有效期开始时间
├─ end_time	string	非必须		有效期结束时间
├─ is_use	number	非必须		是否已使用：0=未使用，1=已使用
├─ is_expired	number	非必须		是否已过期：0=未过期，1=已过期
├─ receive_type	string	非必须		获取来源
├─ name	string	非必须		优惠券名称
├─ pic_url	number	非必须		优惠券图片
├─ desc	string	非必须
├─ rule	string	非必须		使用说明
├─ appoint_type	string	非必须		指定方式1--指定分类 2--指定商品 3--通用
├─ goods	string []	非必须		指定商品名称集合	item 类型: string
├─		非必须
├─ cat	string []	非必须		指定分类集合	item 类型: string
├─		非必须

收藏

取消商品收藏

基本信息

Path： /user/favorite-remove

Method： GET

接口描述：

用户取消商品收藏

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
goods_id	是	8	商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须		返回码 0--成功 1--失败
msg	string	非必须		安徽说明
data	boolean	必须		true--添加收藏 false--取消收藏

我的收藏分类

基本信息

Path： /api/user/favorite-cats

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须
├─ name	string	必须

我的收藏列表（商品）

基本信息

Path： /user/my-new-favorite-goods

Method： GET

接口描述：

我的收藏列表（商品）

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
page	否	1
cat_id	否	16090	分类id
status	否	2	1:低库存 2:已失效 3:降价

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ goods	object	必须
├─ id	number	非必须		商品ID
├─ goods_warehouse_id	number	非必须		商品库id
├─ mch_id	number	非必须
├─ sign	string	非必须		插件标识
├─ name	string	非必须		商品名称
├─ cover_pic	string	非必须
├─ video_url	string	非必须
├─ original_price	string	非必须
├─ unit	string	非必须
├─ page_url	string	非必须
├─ is_negotiable	number	非必须
├─ is_level	number	非必须
├─ level_price	number	非必须
├─ price	string	非必须
├─ price_content	string	非必须
├─ is_sales	string	非必须
├─ sales	string	非必须
├─ attr_groups	object []	非必须			item 类型: object
├─ attr_group_id	number	必须
├─ attr_group_name	string	必须
├─ attr_list	object []	必须			item 类型: object
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ attr	object []	非必须			item 类型: object
├─ id	number	必须
├─ goods_id	number	必须
├─ sign_id	string	必须
├─ stock	number	必须
├─ price	string	必须
├─ no	string	必须
├─ weight	number	必须
├─ pic_url	string	必须
├─ is_delete	number	必须
├─ attr_list	object []	必须			item 类型: object
├─ attr_group_name	string	必须
├─ attr_group_id	number	必须
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ goods_stock	number	非必须
├─ goods_num	number	非必须
├─ vip_card_appoint	object	非必须
├─ discount	null,string	非必须
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ is_invalid	boolean	非必须		是否失效
├─ is_low_price	boolean	非必须		是否降价
├─ is_low_stock	boolean	非必须		是否低库存

我的收藏（专题）

基本信息

Path： /user/my-favorite-topic

Method： GET

接口描述：

我的收藏（专题）

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
x-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
page	是		分页数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须		专题ID
├─ mall_id	string	非必须
├─ type	string	非必须		专题分类
├─ title	string	非必须		专题标题
├─ sub_title	string	非必须		副标题
├─ content	string	非必须		专题内容
├─ layout	string	非必须		布局方式：0=小图，1=大图模式
├─ sort	string	非必须		排序
├─ cover_pic	string	非必须		封面图
├─ read_count	string	非必须		阅读数
├─ agree_count	string	非必须		点赞数
├─ virtual_read_count	string	非必须		虚拟阅读数
├─ virtual_agree_count	string	非必须		虚拟点赞数
├─ virtual_favorite_count	string	非必须		虚拟收藏数
├─ qrcode_pic	string	非必须
├─ is_chosen	string	非必须
├─ is_delete	string	非必须
├─ deleted_at	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ goods_count	number	非必须		商品数

批量取消收藏

基本信息

Path： /api/user/favorite-batch-remove

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
goods_ids[]	text	是	74200	收藏的商品id，是个数组

返回数据

名称	类型	是否必须	默认值	备注	其他信息

添加商品收藏

基本信息

Path： /user/favorite-add

Method： GET

接口描述：

用户添加商品收藏

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
goods_id	是	8	商品ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须		返回码 0--成功 1--失败
msg	string	非必须		返回说明
data	boolean	非必须		true--添加收藏 false--取消收藏

文章

文章列表

基本信息

Path： /default/article-list

Method： GET

接口描述：

文章列表

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须		文章列表	item 类型: object
├─ id	string	非必须		文章ID
├─ mall_id	string	非必须		商城ID
├─ article_cat_id	string	非必须		文章分类ID 1--关于我们 2--服务中心
├─ title	string	非必须		文章标题
├─ content	string	非必须		文章内容 html格式
├─ sort	string	非必须		文章排序
├─ is_delete	string	非必须
├─ deleted_at	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

文章详情

基本信息

Path： /default/article

Method： GET

接口描述：

文章详情

请求参数

Query

参数名称	是否必须	示例	备注
article_id	是	1	文章ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ article	object	非必须
├─ id	string	非必须		文章ID
├─ mall_id	string	非必须		商城ID
├─ article_cat_id	string	非必须		文章分类ID 1--关于我们 2--服务中心
├─ title	string	非必须		文章标题
├─ content	string	非必须		文章内容html格式
├─ sort	string	非必须		文章排序
├─ is_delete	string	非必须
├─ deleted_at	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须

快速购买

分类商品

基本信息

Path： /quick/good-list

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ count	string	非必须		购物车数量
├─ list	object []	非必须		商品信息	item 类型: object
├─ id	number	必须
├─ cover_pic	string	必须		封面图
├─ name	string	必须		商品名称
├─ virtual_sales	number	必须		销量
├─ price	string	必须		价格
├─ use_attr	number	必须		是否使用规格1：开启 0关闭
├─ cart	string []	必须		购物车数据	item 类型: string
├─		非必须
├─ attr	object []	必须		规格数据	item 类型: object
├─ id	number	必须
├─ goods_id	number	必须
├─ sign_id	string	必须
├─ stock	number	必须
├─ price	string	必须
├─ no	string	必须
├─ weight	number	必须
├─ pic_url	string	必须
├─ is_delete	number	必须
├─ attr_list	object []	必须			item 类型: object
├─ attr_group_name	string	必须
├─ attr_group_id	number	必须
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ price_member	number	必须
├─ member_price_list	object []	必须			item 类型: object
├─ id	number	必须
├─ level	number	必须
├─ price	string	必须
├─ goods_attr_id	number	必须
├─ is_delete	number	必须
├─ goods_id	number	必须
├─ member_price_2	number	必须
├─ member_price_3	number	必须
├─ goods_num	number	必须		商品总数
├─ total_num	number	必须
├─ attr_groups	object []	必须		规格组信息	item 类型: object
├─ attr_group_id	number	必须
├─ attr_group_name	string	必须
├─ attr_list	object []	必须			item 类型: object
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ is_level	number	必须		是否启用会员价 0关闭 1开启
├─ level_show	number	必须		是否显示会员价
├─ level_price	number	必须		会员价
├─ vip_card_appoint	object	必须
├─ discount	string,null	非必须		折扣
├─ is_my_vip_card_goods	number	非必须		是否超级vip商品
├─ is_vip_card_user	number	非必须		是否vip用户

快速购买首页

基本信息

Path： /quick/index

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ count	string	非必须		购物车数量
├─ cats_list	object []	非必须		分类列表	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ parent_id	string	必须		父级id
├─ name	string	必须		分类名称
├─ pic_url	string	必须		分类图片
├─ sort	string	必须		排序
├─ big_pic_url	string	必须		大图： 分类图
├─ advert_pic	string	必须		广告图
├─ advert_url	string	必须		广告跳转路径
├─ status	string	必须		状态 0关 1开启
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_show	string	必须		0 不显示 1显示
├─ hot_list	string []	非必须		已删除	item 类型: string
├─		非必须

购物车

基本信息

Path： /quick/cart

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	0DBfMLNTV2H_EqWr1fn7zowiROUfwind	是

Body

参数名称	参数类型	是否必须	示例	备注
list	text	是	[{"attr":"72","num":1,"good_id":"17"}]	改动购物车

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

收货地址

地址保存

基本信息

Path： /user/address-save

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	0DBfMLNTV2H_EqWr1fn7zowiROUfwind	是

Body

参数名称	参数类型	是否必须	示例	备注
name	text	是	1	收货人
province_id	text	是	1	省
city_id	text	是	3	市
district_id	text	是	4	区
mobile	text	是	18282828282	号码
detail	text	是	北京朝阳	地址详情
id	text	否	1	地址id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

地址删除

基本信息

Path： /user/address-destroy

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	1	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

地址详情

基本信息

Path： /user/address-detail

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	0DBfMLNTV2H_EqWr1fn7zowiROUfwind	是

Query

参数名称	是否必须	示例	备注
id	是	1	地址id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须
├─ id	number	非必须
├─ user_id	number	非必须
├─ name	string	非必须
├─ province_id	number	非必须
├─ province	string	非必须		省
├─ city_id	number	非必须
├─ city	string	非必须		市
├─ district_id	number	非必须
├─ district	string	非必须		县
├─ mobile	string	非必须
├─ detail	string	非必须		详细地址
├─ is_default	number	非必须		是否默认
├─ is_delete	number	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须

地址默认

基本信息

Path： /user/address-default

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	0DBfMLNTV2H_EqWr1fn7zowiROUfwind	是

Body

参数名称	参数类型	是否必须	示例	备注
is_default	text	是	1	是否默认
id	text	是	1	地址id

返回数据

名称	类型	是否必须	默认值	备注	其他信息

微信省市区

基本信息

Path： /user/wechat-district

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
province_name	是	北京市	省
city_name	是	北京市	市
county_name	是	朝阳区	区

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ district	object	非必须
├─ province	object	非必须		省
├─ id	number	非必须
├─ name	string	非必须
├─ city	object	非必须		市
├─ id	number	非必须
├─ name	string	非必须
├─ district	object	非必须		区
├─ id	number	非必须
├─ name	string	非必须

用户收货首页

基本信息

Path： /user/address

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1	页码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须		收货列表	item 类型: object
├─ id	string	必须
├─ user_id	string	必须
├─ name	string	必须		收货人
├─ province_id	string	必须
├─ province	string	必须		省份名称
├─ city_id	string	必须
├─ city	string	必须		城市名称
├─ district_id	string	必须
├─ district	string	必须		县区名称
├─ mobile	string	必须
├─ detail	string	必须		详细地址
├─ is_default	string	必须		是否默认
├─ is_delete	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ address	string	必须		省市区拼接

default

3级分类

基本信息

Path： /cat/goods

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
cat_id	是	123	3级分类id
cat_ids	是	[1,3,4,123]	3级分类组
offset	是	0	偏移量

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须
├─ mall_id	number	必须
├─ mch_id	number	必须
├─ parent_id	number	必须
├─ name	string	必须
├─ pic_url	string	必须
├─ sort	number	必须
├─ big_pic_url	string	必须
├─ advert_pic	string	必须
├─ advert_url	string	必须
├─ status	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	number	必须
├─ is_show	number	必须
├─ advert_open_type	string	必须
├─ advert_params	string	必须
├─ goods_list	object []	必须			item 类型: object
├─ id	number	必须
├─ goods_warehouse_id	number	必须
├─ mch_id	number	必须
├─ sign	string	必须
├─ name	string	必须
├─ cover_pic	string	必须
├─ video_url	string	必须
├─ original_price	string	必须
├─ unit	string	必须
├─ page_url	string	必须
├─ is_negotiable	number	必须
├─ is_level	number	必须
├─ level_price	number	必须
├─ price	string	必须
├─ price_content	string	必须
├─ is_sales	string	必须
├─ sales	string	必须
├─ attr_groups	object []	必须			item 类型: object
├─ attr_group_id	number	必须
├─ attr_group_name	string	必须
├─ attr_list	object []	必须			item 类型: object
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ pic_url	string	必须
├─ attr	object []	必须			item 类型: object
├─ id	number	必须
├─ goods_id	number	必须
├─ sign_id	string	必须
├─ stock	number	必须
├─ price	string	必须
├─ no	string	必须
├─ weight	number	必须
├─ pic_url	string	必须
├─ is_delete	number	必须
├─ attr_list	object []	必须			item 类型: object
├─ attr_group_name	string	必须
├─ attr_group_id	number	必须
├─ attr_id	number	必须
├─ attr_name	string	必须
├─ goods_stock	number	必须
├─ vip_card_appoint	object	必须
├─ discount	null	非必须
├─ is_my_vip_card_goods	number	非必须
├─ is_vip_card_user	number	非必须
├─ offset	number	必须

分类列表

基本信息

Path： /cat/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
cat_id	是	1	分类id
mch_id	否	0	多商户id
select_cat_id	是	1	cat_list 中选中的 cat_id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须		分类列表	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ parent_id	string	必须		父分类id
├─ name	string	必须		分类名称
├─ pic_url	string	必须		分类图标
├─ sort	string	必须		分类排序
├─ big_pic_url	string	必须		分类大图
├─ advert_pic	string	必须		分类广告图
├─ advert_url	string	必须		分类广告链接
├─ status	string	必须		是否启用
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_show	string	必须		是否显示
├─ child	object []	必须		子分类	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ parent_id	string	必须
├─ name	string	必须
├─ pic_url	string	必须
├─ sort	string	必须
├─ big_pic_url	string	必须
├─ advert_pic	string	必须
├─ advert_url	string	必须
├─ status	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_show	string	必须
├─ child	object []	必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ parent_id	string	必须
├─ name	string	必须
├─ pic_url	string	必须
├─ sort	string	必须
├─ big_pic_url	string	必须
├─ advert_pic	string	必须
├─ advert_url	string	必须
├─ status	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ is_show	string	必须
├─ page_url	string	必须
├─ active	boolean	必须
├─ page_url	string	必须
├─ active	boolean	必须
├─ page_url	string	必须
├─ active	boolean	必须

商品列表

基本信息

Path： /default/goods-list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
cat_id	否	1	分类id
sort	否	1	自定义排序+时间最新=1 时间最新=2 价格=3 销量=4
sort	否	1	价格正序=1 价格倒叙=0
keyword	否	1	关键字
page	否	1	页码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ mch_id	string	必须
├─ name	string	必须
├─ price	string	必须
├─ original_price	string	必须		原价
├─ cost_price	string	必须		成本价
├─ detail	string	必须		详情
├─ status	string	必须		上架状态：0=下架，1=上架
├─ use_attr	string	必须		是否启用规格
├─ cover_pic	string	必须		商品缩略图
├─ pic_url	object []	必须		海报缩略图	item 类型: object
├─ id	string	必须
├─ pic_url	string	必须
├─ video_url	string	必须
├─ unit	string	必须		单位
├─ virtual_sales	string	必须		虚拟销量
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ sort	string	必须
├─ is_quick_shop	string	必须		1:快速购买 0 不是快速购买
├─ is_sell_well	string	必须		1：热销 0：非热销
├─ is_level	string	必须		0 启用会员价 1不启用
├─ price_content	string	必须
├─ page_url	string	必须		跳转路径
├─ is_negotiable	number	必须		0不面议 1面议
├─ sales	string	必须		销量

省市区

基本信息

Path： /default/district

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须		省市区列表	item 类型: object
├─ id	number	必须
├─ name	string	必须		名称
├─ parent_id	number	必须		上级省
├─ level	string	必须		类型	枚举: district,city,province
├─ list	object []	必须			item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ parent_id	number	必须
├─ level	string	必须
├─ list	object []	必须			item 类型: object
├─ id	number	必须
├─ name	string	必须
├─ parent_id	number	必须
├─ level	string	必须

附件

附件上传

基本信息

Path： /attachment/upload

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	multipart/form-data	是

Body

参数名称	参数类型	是否必须	示例	备注
file	file	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

余额充值

余额充值设置

基本信息

Path： /api/recharge/setting

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ setting	object	非必须
├─ status	string	非必须		充值状态 0.关|1开
├─ type	string	非必须		是否开放自定义金额
├─ bj_pic_url	object	非必须		背景图片信息
├─ id	string	非必须
├─ storage_id	string	非必须
├─ user_id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ size	string	非必须
├─ url	string	非必须
├─ thumb_url	string	非必须
├─ type	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ attachment_group_id	string	非必须
├─ checked	string	非必须
├─ selected	string	非必须
├─ ad_pic_url	object	非必须		广告图片信息
├─ id	string	非必须
├─ storage_id	string	非必须
├─ user_id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ size	string	非必须
├─ url	string	非必须
├─ thumb_url	string	非必须
├─ type	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ attachment_group_id	string	非必须
├─ checked	string	非必须
├─ selected	string	非必须
├─ page_url	string	非必须		页面链接
├─ re_pic_url	object	非必须		充值图片信息
├─ id	string	非必须
├─ storage_id	string	非必须
├─ user_id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ size	string	非必须
├─ url	string	非必须
├─ thumb_url	string	非必须
├─ type	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ attachment_group_id	string	非必须
├─ checked	string	非必须
├─ selected	string	非必须
├─ explain	string	非必须		备注

余额日志记录

基本信息

Path： /balance/logs

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
type	否	1	类型 1.收入
page	否	1	分页
date	是	2019-10	日期

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须		记录ID
├─ user_id	string	必须		用户ID
├─ type	string	必须		类型：1=收入，2=支出
├─ money	string	必须		变动金额
├─ desc	string	必须		变动说明
├─ custom_desc	string	必须		该字段前端无用
├─ created_at	string	必须

充值

基本信息

Path： /recharge/balance-recharge

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
pay_price	text	是	30.11	充值金额
send_price	text	是	10	赠送金额

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ pay_id	number	非必须		微信支付ID

充值金额列表

基本信息

Path： /recharge/index

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须
├─ mall_id	number	必须		商城ID
├─ name	string	必须		充值名称
├─ pay_price	string	必须		充值金额
├─ send_price	string	必须		赠送金额
├─ is_delete	number	必须		是否删除
├─ created_at	string	必须		创建时间
├─ updated_at	string	必须		更新时间
├─ deleted_at	string	必须		删除时间

首页

基本信息

Path： /balance/index

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ setting	object	非必须		充值设置
├─ status	string	非必须		是否开启余额功能0.关闭1.开启
├─ type	string	非必须		是否开放自定义金额 0.关闭1.开启
├─ bj_pic_url	object	非必须		背景图片
├─ id	string	非必须
├─ storage_id	string	非必须
├─ user_id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ size	string	非必须
├─ url	string	非必须
├─ type	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ ad_pic_url	object	非必须		广告图片
├─ id	string	非必须
├─ storage_id	string	非必须
├─ user_id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ size	string	非必须
├─ url	string	非必须
├─ type	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ page_url	string	非必须		广告图片跳转链接
├─ re_pic_url	object	非必须		充值说明图标
├─ id	string	非必须
├─ storage_id	string	非必须
├─ user_id	string	非必须
├─ mall_id	string	非必须
├─ name	string	非必须
├─ size	string	非必须
├─ url	string	非必须
├─ thumb_url	string	非必须
├─ type	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ checked	string	非必须
├─ explain	string	非必须		充值说明

合伙人

提现明细

基本信息

Path： /share/cash-list

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
x-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
status	是		状态吗 -1--全部 0--申请中 1--申请通过，待打款 2--已打款 3--驳回
page	是		当前页

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	必须		提现记录ID
├─ order_no	string	必须		提现记录单号
├─ pay_type	string	必须		提现方式文本
├─ type	string	必须		提现方式 'auto'--自动打款 wechat--微信 alipay--支付宝 bank--银行 balance--提现到余额
├─ status	number	必须		提现记录状态 0--申请中 1--已通过，待打款 2--已打款 3--已驳回
├─ status_text	string	必须		提现记录状态文本
├─ user	object	必须		用户信息
├─ avatar	string	非必须		用户头像
├─ nickname	string	非必须		用户昵称
├─ platform	string	非必须		用户所属平台 wx--微信
├─ cash	object	必须		提现信息
├─ price	number	非必须		提现金额
├─ service_charge	number	非必须		提现手续费
├─ actual_price	number	非必须		提现实际金额
├─ extra	object	必须		额外信息
├─ name	string	非必须		微信昵称/支付宝昵称/开户人
├─ mobile	string	非必须		微信号/支付宝账号/银行卡号
├─ bank_name	string	非必须		开户行
├─ time	object	必须		时间
├─ created_at	string	非必须		提交时间
├─ apply_at	string	非必须		审核时间
├─ remittance_at	string	非必须		打款时间
├─ reject_at	string	非必须		驳回时间

合伙人佣金

基本信息

Path： /share/brokerage

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须
├─ total_money	string	非必须		合伙人佣金
├─ money	string	非必须		可提现
├─ un_pay	number	非必须		待打款
├─ cash_money	number	非必须		已提现
├─ total_cash	number	非必须		提现明细

合伙人等级立即升级

基本信息

Path： /api/share/level-up

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ status	number	非必须		是否升级失败	枚举: 0,1 枚举备注: 0--失败 1--成功
├─ level_name	string	非必须		升级说明
├─ condition_text	string	非必须		升级条件说明

合伙人订单

基本信息

Path： /share/share-order

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
page	是
status	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ order_no	string	必须		订单号
├─ nickname	string	必须		下单用户昵称
├─ avatar	string	必须		下单用户头像
├─ status	string	必须		订单状态
├─ share_status	object,string	必须		合伙人层级
├─ created_at	string	必须		下单时间
├─ is_sale	number	必须		是否发放佣金
├─ share_money	number	必须		合伙人金额
├─ goods_list	object []	必须		商品列表	item 类型: object
├─ id	number	必须		商品id
├─ num	number	必须		商品数量
├─ name	string	必须		商品名称
├─ cover_pic	string	必须		商品图片
├─ attr_list	object []	必须		商品规格	item 类型: object
├─ attr_group_name	string	必须
├─ attr_name	string	必须

合伙人设置

基本信息

Path： /share/setting

Method： GET

接口描述：

合伙人配置

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
x-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ config	object	非必须
├─ level	number	非必须		合伙人层级
├─ is_rebate	number	非必须		是否内购
├─ price_type	number	非必须		佣金类型 1--百分比 2--固定金额
├─ first	number	非必须		一级佣金
├─ second	number	非必须		二级佣金
├─ third	number	非必须		三级佣金
├─ share_condition	number	非必须		成为合伙人条件 1--无条件（需要审核） 2--申请（需要审核） 3--无需审核
├─ condition	number	非必须		成为下级条件 1--首次链接 2--首次下单 3--首付款
├─ auto_share_val	number	非必须		消费满自动成为合伙人
├─ share_goods_status	number	非必须		购买商品成为合伙人 0--关闭 1--任意商品 2--指定商品
├─ share_goods_id	number	非必须		指定的商品ID
├─ pay_type	string []	非必须		提现方式	item 类型: string
├─		非必须
├─ cash_max_day	number	非必须		今日最大可提现额度
├─ min_money	number	非必须		最少提现金额
├─ cash_service_charge	number	非必须		提现手续费（%）
├─ agree	string	非必须		申请协议
├─ content	string	非必须		用户须知
├─ pic_url_apply	string	非必须		申请页面图片
├─ pic_url_status	string	非必须		审核页面图片
├─ surplusCash	number	非必须		今日剩余可提现额度

合伙人首页

基本信息

Path： /share/index

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须
├─ order_money	number	非必须		订单总额
├─ order_money_un	number	非必须		未结算佣金
├─ team_count	number	非必须		团队人数
├─ total_money	string	非必须		合伙人佣金
├─ money	string	非必须		可提现佣金
├─ un_pay	number	非必须		待打款
├─ cash_money	number	非必须		已提现
├─ total_cash	number	非必须		提现明细

提现

基本信息

Path： /share/cash

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
x-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Body

参数名称	参数类型	是否必须	示例	备注
price	text	是		提现金额
type	text	是		提现方式 auto--自动打款 wechat--微信 alipay--支付宝 bank--银行卡 balance--余额
name	text	是		微信昵称/支付宝昵称/开户人
mobile	text	是		微信号/支付宝账号/开户号
bank_name	text	是		开户行

合伙人等级升级条件

基本信息

Path： /api/share/level

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ condition_type	number	必须		升级条件	枚举: 1,2,3 枚举备注: 1--下线人数 2--累计佣金 3--已提现佣金
├─ condition	number	必须		升级数量

申请合伙人

基本信息

Path： /share/apply

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Body

参数名称	参数类型	是否必须	示例	备注
name	text	是	cc	合伙人名称
mobile	text	是	123	合伙人手机号
agree	text	是	0

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ name	string	必须

申请状态查询

基本信息

Path： /share/apply-status

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ share	object	非必须		合伙人信息
├─ status	string	非必须		合伙人申请状态0--申请中 1--成功 2--失败

申请状态查询--合伙人等级之后版本

基本信息

Path： /api/share/new-apply-status

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ share	object	非必须		合伙人信息
├─ id	number	非必须
├─ mall_id	number	非必须
├─ user_id	number	非必须
├─ name	string	非必须
├─ mobile	string	非必须
├─ content	null	非必须
├─ level	number	非必须		合伙人等级
├─ level_at	string	非必须
├─ status	number	非必须		展示的状态	枚举: 0,1,2,3,4 枚举备注: 0--合伙人申请中 1--已经是合伙人 2--可以申请合伙人 3--条件未满足 4--合伙人申请被拒绝 5--合伙人被删除
├─ orderPrice	null	非必须		单次消费金额
├─ goodsList	null	非必须		购买指定的商品列表
├─ catList	null	非必须		购买指定的分类列表

绑定合伙人关系

基本信息

Path： /share/bind-parent

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
parent_id	是		绑定的上级user_id
condition	是		成为下级条件

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

自定义

基本信息

Path： /share/customize

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须
├─ code	number	非必须
├─ data	object	非必须
├─ menus	object	非必须
├─ money	object	非必须		合伙人佣金
├─ name	string	非必须		名称（下同）
├─ icon	string	非必须		图标（下同）
├─ open_type	string	非必须		跳转方式（下同）
├─ url	string	非必须		路径（下同）
├─ tel	string	非必须
├─ order	object	非必须		合伙人订单
├─ name	string	非必须
├─ icon	string	非必须
├─ open_type	string	非必须
├─ url	string	非必须
├─ tel	string	非必须
├─ cash	object	非必须		提现明细
├─ name	string	非必须
├─ icon	string	非必须
├─ open_type	string	非必须
├─ url	string	非必须
├─ tel	string	非必须
├─ team	object	非必须		我的团队
├─ name	string	非必须
├─ icon	string	非必须
├─ open_type	string	非必须
├─ url	string	非必须
├─ tel	string	非必须
├─ qrcode	object	非必须		推广二维码
├─ name	string	非必须
├─ icon	string	非必须
├─ open_type	string	非必须
├─ url	string	非必须
├─ tel	string	非必须
├─ words	object	非必须
├─ can_be_presented	object	非必须		可提现佣金
├─ name	string	非必须
├─ default	string	非必须
├─ already_presented	object	非必须		已提现佣金
├─ name	string	非必须
├─ default	string	非必须
├─ parent_name	object	非必须		推荐人
├─ name	string	非必须
├─ default	string	非必须
├─ pending_money	object	非必须		待打款佣金
├─ name	string	非必须
├─ default	string	非必须
├─ cash	object	非必须		提现
├─ name	string	非必须
├─ default	string	非必须
├─ user_instructions	object	非必须		用户须知
├─ name	string	非必须
├─ default	string	非必须
├─ apply_cash	object	非必须		我要提现
├─ name	string	非必须
├─ default	string	非必须
├─ cash_type	object	非必须		提现方式
├─ name	string	非必须
├─ default	string	非必须
├─ cash_money	object	非必须		提现金额
├─ name	string	非必须
├─ default	string	非必须
├─ order_money_un	object	非必须		未结算佣金
├─ name	string	非必须
├─ default	string	非必须
├─ share_name	object	非必须		合伙人
├─ name	string	非必须
├─ default	string	非必须
├─ one_share	object	非必须		一级合伙人名称
├─ name	string	非必须
├─ default	string	非必须
├─ second_share	object	非必须		二级合伙人名称
├─ name	string	非必须
├─ default	string	非必须
├─ three_share	object	非必须		三级合伙人名称
├─ name	string	非必须
├─ default	string	非必须

获取团队详情

基本信息

Path： /share/team

Method： GET

接口描述：

合伙人团队详情

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
x-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
status	是		合伙人层级
page	是		列表分页

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	number	非必须
├─ nickname	string	非必须		用户昵称
├─ peopleCount	number	非必须		推广人数
├─ orderCount	number	非必须		合伙人订单数
├─ orderPrice	number	非必须		合伙人订单消费金额
├─ avatar	string	非必须		用户头像
├─ junior_at	string	非必须		成为下级时间
├─ first_count	integer	必须		一级人数
├─ second_count	integer	必须		二级人数
├─ third_count	integer	必须		三级人数

视频专区

视频列表

基本信息

Path： /video/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	是	1

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ title	string	非必须		标题
├─ type	string	非必须		类型
├─ url	string	非必须		视频url
├─ pic_url	string	非必须		封面图
├─ content	string	非必须		详情
├─ sort	string	非必须		排序
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ time	string	非必须		日期格式化

视频播放接口

基本信息

Path： /video/play

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
X-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

Query

参数名称	是否必须	示例	备注
url	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息

购物车

列表

基本信息

Path： /cart/list

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ user_id	string	必须
├─ goods_id	string	必须
├─ attr	null	必须		规格信息
├─ num	string	必须
├─ mch_id	string	必须
├─ is_delete	string	必须
├─ created_at	string	必须
├─ deleted_at	string	必须
├─ updated_at	string	必须
├─ goods	null	必须		商品信息

批量删除

基本信息

Path： /cart/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
cart_id_list	text	是	"[1,2,3]"	购物车id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

批量编辑

基本信息

Path： /cart/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
list	text	是	[{"attr":"67","num":778,"good_id":"10"}]	改动的部分 json

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

购物车添加

基本信息

Path： /cart/add

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
X-Access-Token	0DBfMLNTV2H_EqWr1fn7zowiROUfwind	是

Body

参数名称	参数类型	是否必须	示例	备注
goods_id	text	是	1	商品id
attr	text	是	1	规格id
num	text	是	1	商品数量

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

user

余额日志记录

基本信息

Path： /api/balance/log-detail

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Query

参数名称	是否必须	示例	备注
id	是	1	日志ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ user_id	number	非必须
├─ type	number	非必须
├─ money	string	非必须
├─ desc	string	非必须
├─ custom_desc	string	非必须
├─ created_at	string	非必须

发送验证码

基本信息

Path： /user/phone-code

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
mobile	是		手机号码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

手机手动绑定

基本信息

Path： /user/phone-empower

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
mobile	text	是		手机号码
code	text	是		验证码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ mobile	string	非必须		手机号码

手机绑定

基本信息

Path： /phone/binding

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
code	text	是
encryptedData	text	是
iv	text	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

用户信息

基本信息

Path： /user/user-info

Method： GET

接口描述：

用户信息

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
x-Access-Token	FE4TMNYuBiGV38miWSEtl6ImDtI2uaZW	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ nickname	string	非必须		用户昵称
├─ mobile	string	非必须		用户绑定手机号
├─ options	object	非必须
├─ id	number	非必须
├─ user_id	number	非必须		用户id
├─ avatar	string	非必须		用户头像
├─ integral	number	非必须		可用积分
├─ total_integral	number	非必须		总积分
├─ balance	string	非必须		余额
├─ parent_id	number	非必须		上级id
├─ is_blacklist	number	非必须		是否拉黑
├─ contact_way	string	非必须		联系方式
├─ remark	string	非必须		备注
├─ is_delete	number	非必须
├─ junior_at	string	非必须		成为下级时间
├─ store_id	number	非必须		所属门店
├─ identity	object	非必须
├─ parent_name	string	非必须		上级合伙人昵称
├─ levelName	string	非必须		用户会员名称

会员中心

会员专属商品分类列表

基本信息

Path： /api/mall-member/goods-cats

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1	分页

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须		分类列表	item 类型: object
├─ id	number	必须		分类ID
├─ mall_id	number	必须		商品ID
├─ parent_id	number	必须		分类父级ID
├─ name	string	必须		分类名称
├─ pic_url	string	必须		分类图标
├─ sort	number	必须		分类排序
├─ big_pic_url	string	必须		分类大图
├─ advert_pic	string	必须
├─ advert_url	string	必须
├─ status	number	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	number	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

会员专属商品列表

基本信息

Path： /api/mall-member/member-goods

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1	分页
cats_id	否	1	分类ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须		会员商品列表	item 类型: object
├─ id	number	非必须		商品ID
├─ mall_id	number	非必须		商城ID
├─ mch_id	number	非必须		多商户ID
├─ name	string	非必须		商品名称
├─ price	string	非必须		商品价格
├─ original_price	string	非必须		商品原价
├─ cost_price	string	非必须
├─ detail	string	非必须
├─ status	number	非必须
├─ use_attr	number	非必须
├─ attr_groups	string	非必须
├─ cover_pic	string	非必须		商品大图
├─ pic_url	string	非必须		商品图片
├─ video_url	string	非必须
├─ unit	string	非必须
├─ virtual_sales	number	非必须
├─ sort	number	非必须
├─ is_quick_shop	number	非必须
├─ is_sell_well	number	非必须
├─ is_level	number	非必须
├─ confine_count	number	非必须
├─ give_integral	number	非必须
├─ give_integral_type	number	非必须
├─ forehead_integral	number	非必须
├─ forehead_integral_type	number	非必须
├─ accumulative	number	非必须
├─ is_negotiable	number	非必须
├─ freight_id	number	非必须
├─ pieces	string	非必须
├─ forehead	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	number	非必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

会员优惠券列表

基本信息

Path： /api/mall-member/member-coupon

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1	分页

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须		优惠券列表	item 类型: object
├─ id	number	必须		优惠券ID
├─ mall_id	number	必须		商城ID
├─ name	string	必须		优惠券名称
├─ type	number	必须		优惠券类型
├─ discount	string	必须		优惠券折扣
├─ pic_url	number	必须		优惠券图标
├─ desc	string	必须		优惠券备注、描述
├─ min_price	string	必须		最低消费金额
├─ sub_price	string	必须		优惠金额
├─ total_count	number	必须		发放总数量
├─ is_join	number	必须		是否加入领券中心 1--不加入领券中心 2--加入领券中心
├─ sort	number	必须		排序
├─ expire_type	number	必须		到期类型：1=领取后N天过期，2=指定有效期
├─ expire_day	number	必须		有效天数，expire_type=1时
├─ begin_time	string	必须		有效期开始时间
├─ end_time	string	必须		有效期结束时间
├─ appoint_type	number	必须		1 指定商品 2 指定商品 3全部
├─ rule	string	必须		使用说明
├─ is_delete	number	必须
├─ deleted_at	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

会员列表

基本信息

Path： /api/mall-member/all-member

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page	否	1	分页

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ list	object []	非必须		会员列表	item 类型: object
├─ id	string	必须		会员ID
├─ mall_id	string	必须		商城ID
├─ level	string	必须		会员等级
├─ name	string	必须		会员名称
├─ auto_update	string	必须		满金额是否自动升级0.否1.是
├─ money	string	必须		升级会员所需消费金额
├─ discount	string	必须		会员折扣
├─ status	string	必须		会员状态
├─ pic_url	string	必须		会员图标
├─ is_purchase	string	必须		是否可购买0.否1.是
├─ price	string	必须		会员购买价格
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	string	必须
├─ rights	object []	必须		会员权益列表	item 类型: object
├─ id	string	必须		权益ID
├─ member_id	string	必须		关联会员ID
├─ title	string	必须		权益标题
├─ content	string	必须		权益内容
├─ pic_url	string	必须		权益图标
├─ is_delete	string	必须
├─ pagination	object	非必须
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

会员详情

基本信息

Path： /api/mall-member/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
api/mall-member/detail	是	2	会员ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ detail	object	非必须		会员详情
├─ id	string	非必须
├─ mall_id	string	非必须
├─ level	string	非必须
├─ name	string	非必须
├─ auto_update	string	非必须		累计金额是否自动升级0.否1.是
├─ money	string	非必须
├─ discount	string	非必须
├─ status	string	非必须
├─ pic_url	string	非必须
├─ is_purchase	string	非必须		是否可购买0.否1.是
├─ price	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ rights	object []	非必须			item 类型: object
├─ id	string	必须
├─ member_id	string	必须
├─ title	string	必须
├─ content	string	必须
├─ pic_url	string	必须
├─ is_delete	string	必须

购买会员

基本信息

Path： /mall-member/purchase-member

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
member_level	text	是	5	购买会员的会员等级

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ pay_id	number	非必须		支付ID

首页

基本信息

Path： /api/mall-member/index

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须
data	object	非必须
├─ consumption_money	number	非必须		用户总消费金额
├─ mall_member	object	非必须		用户当前会员信息
├─ id	string	非必须		会员ID
├─ mall_id	string	非必须		商城ID
├─ level	string	非必须		会员等级
├─ name	string	非必须		会员名称
├─ money	string	非必须		消费此金额可升级会员
├─ discount	string	非必须		会员折扣
├─ status	string	非必须		会员状态
├─ pic_url	string	非必须		会员图标
├─ price	string	非必须		会员购买价格
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ rights	object []	非必须		会员权益列表	item 类型: object
├─ id	string	必须		权益ID
├─ member_id	string	必须		会员ID
├─ title	string	必须		权益标题
├─ content	string	必须		权益内容
├─ pic_url	string	必须		权益图标
├─ is_delete	string	必须
├─ next_mall_member	object []	非必须		下一级会员列表	item 类型: object
├─ id	string	非必须
├─ mall_id	string	非必须
├─ level	string	非必须
├─ name	string	非必须
├─ money	string	非必须
├─ discount	string	非必须
├─ status	string	非必须
├─ pic_url	string	非必须
├─ price	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ is_delete	string	非必须
├─ rights	object []	非必须			item 类型: object
├─ id	string	非必须
├─ member_id	string	非必须
├─ title	string	非必须
├─ content	string	非必须
├─ pic_url	string	非必须
├─ is_delete	string	非必须
├─ member_goods	object []	非必须		会员专属商品列表	item 类型: object
├─ id	number	必须		商品ID
├─ mall_id	number	必须		商城ID
├─ mch_id	number	必须		多商户ID
├─ name	string	必须		商品名称
├─ price	string	必须		商品价格
├─ original_price	string	必须		商品原价
├─ cost_price	string	必须
├─ detail	string	必须
├─ status	number	必须
├─ use_attr	number	必须
├─ attr_groups	string	必须
├─ cover_pic	string	必须
├─ pic_url	string	必须		商品图片
├─ video_url	string	必须
├─ unit	string	必须
├─ virtual_sales	number	必须
├─ sort	number	必须
├─ is_quick_shop	number	必须
├─ is_sell_well	number	必须
├─ is_level	number	必须
├─ confine_count	number	必须
├─ give_integral	number	必须
├─ give_integral_type	number	必须
├─ forehead_integral	number	必须
├─ forehead_integral_type	number	必须
├─ accumulative	number	必须
├─ is_negotiable	number	必须
├─ freight_id	number	必须
├─ pieces	string	必须
├─ forehead	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ is_delete	number	必须
├─ member_coupons	object []	非必须		会员专属优惠券列表	item 类型: object
├─ id	number	必须		优惠券ID
├─ mall_id	number	必须		商城ID
├─ name	string	必须		优惠券名称
├─ type	number	必须		优惠券类型
├─ discount	string	必须		折扣
├─ pic_url	number	必须		图标
├─ desc	string	必须		备注、描述
├─ min_price	string	必须		最低消费金额
├─ sub_price	string	必须		优惠金额
├─ total_count	number	必须		发放总数量
├─ is_join	number	必须		是否加入领券中心 1--不加入领券中心 2--加入领券中心
├─ sort	number	必须		排序按升序排列
├─ expire_type	number	必须		到期类型：1=领取后N天过期，2=指定有效期
├─ expire_day	number	必须		有效天数，expire_type=1时
├─ begin_time	string	必须		有效期开始时间
├─ end_time	string	必须		有效期结束时间
├─ appoint_type	number	必须		1 指定商品 2 指定商品 3全部
├─ rule	string	必须		使用说明
├─ is_delete	number	必须
├─ deleted_at	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须

专题

专题分类

基本信息

Path： /topic/type

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ name	string	必须		分类名称
├─ sort	string	必须		排序
├─ is_delete	string	必须
├─ created_at	string	必须
├─ deleted_at	string	必须
├─ updated_at	string	必须

专题列表

基本信息

Path： /topic/list

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
type	是	0	专题分类id 0:全部 -1:精选
page	是	1	分页

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ type	string	必须		分类类型
├─ title	string	必须		标题
├─ sub_title	string	必须		副标题
├─ content	string	必须		详情
├─ layout	string	必须		布局方式：0=小图，1=大图模式 3多图
├─ sort	string	必须		排序
├─ cover_pic	string	必须		封面图
├─ read_count	string	必须		阅读量
├─ agree_count	string	必须		点赞数（未用）
├─ virtual_read_count	string	必须		虚拟阅读量
├─ virtual_agree_count	string	必须		虚拟点赞数（未用）
├─ virtual_favorite_count	string	必须		虚拟收藏量
├─ qrcode_pic	string	必须		海报图
├─ is_chosen	string	必须		是否精选 0不精选 1精选
├─ is_delete	string	必须
├─ deleted_at	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ goods_count	string	必须		商品数

专题详情

基本信息

Path： /topic/detail

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是	3	文章id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须
├─ id	number	非必须
├─ mall_id	number	非必须
├─ type	number	非必须		分类类型id
├─ title	string	非必须		标题
├─ sub_title	string	非必须		副标题
├─ content	string	非必须		详情
├─ layout	number	非必须		布局方式：0=小图，1=大图模式 2=多图
├─ sort	number	非必须		排序
├─ cover_pic_id	number	非必须		图片id
├─ read_count	string	非必须		阅读量
├─ agree_count	number	非必须		点赞数
├─ virtual_read_count	number	非必须		虚拟阅读量
├─ virtual_agree_count	number	非必须		虚拟点赞数（未用）
├─ virtual_favorite_count	number	非必须		虚拟收藏量
├─ qrcode_pic_id	number	非必须
├─ is_chosen	number	非必须		是否精选
├─ is_delete	number	非必须
├─ deleted_at	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ goods_count	string	非必须		商品数
├─ is_favorite	string	非必须		是否收藏0不收藏 1收藏

文章收藏

基本信息

Path： /topic/favorite

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	3	文章id
is_favorite	text	是	no_love	no_love:不喜欢 love 喜欢

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

小票打印后台

列表

基本信息

Path： /printer/index

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page_size	是	1	10

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ type	string	必须		打印机品牌
├─ name	string	必须		打印机名称
├─ setting	string	必须		打印机设置
├─ is_delete	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ select	object []	非必须		打印机选择	item 类型: object
├─ value	string	必须
├─ label	string	必须
├─ pagination	object	非必须		页码
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

删除

基本信息

Path： /printer/destroy

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	1	打印机id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
msg	string	非必须

编辑数据

基本信息

Path： /printer/edit

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	是

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ type	string	非必须		打印机类型
├─ name	string	非必须		打印机名称
├─ setting	object	非必须		打印机配置相关
├─ machine_code	string	非必须
├─ key	string	非必须
├─ client_id	string	非必须
├─ client_key	string	非必须
├─ url	string	非必须
├─ time	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ select	object []	非必须		打印机选择	item 类型: object
├─ value	string	必须
├─ label	string	必须

编辑提交

基本信息

Path： /printer/edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
name	text	是	飞蛾	打印机名称
type	text	是	360-kdt2	打印机类型360-kdt2,yilianyun-k4,feie,gainscha-gp
setting	text	是	{key:123}	打印机配置 数组
id	text	否	1	id存在 表示编辑

返回数据

名称	类型	是否必须	默认值	备注	其他信息

打印设置列表

基本信息

Path： /printer/setting

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
page_size	是	10

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object []	非必须			item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ printer_id	string	必须		打印机id
├─ block_id	string	必须		模板id
├─ status	string	必须		是否启用
├─ is_attr	string	必须		是否使用规格
├─ type	string	必须		打印级配置
├─ is_delete	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须
├─ printer	object	必须		打印机
├─ id	string	非必须
├─ mall_id	string	非必须
├─ type	string	非必须
├─ name	string	非必须		打印机名称
├─ setting	string	非必须
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ pagination	object	非必须		页面
├─ defaultPageSize	number	非必须
├─ pageSize	number	非必须
├─ total_count	number	非必须
├─ page_count	number	非必须
├─ current_page	number	非必须
├─ pageParam	string	非必须
├─ pageSizeParam	string	非必须
├─ forcePageParam	boolean	非必须
├─ route	null	非必须
├─ params	null	非必须
├─ urlManager	null	非必须
├─ validatePage	boolean	非必须
├─ totalCount	number	非必须
├─ pageSizeLimit	number []	非必须			item 类型: number
├─		非必须

打印设置

基本信息

Path： /printer/setting-edit

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
id	否	1	打印设置ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	number	非必须
data	object	非必须
├─ list	object	非必须
├─ id	string	非必须
├─ mall_id	string	非必须
├─ printer_id	string	非必须		打印机id
├─ block_id	string	非必须
├─ status	string	非必须		是否启用
├─ is_attr	string	非必须		是否使用规格
├─ type	number	非必须		打印机配置
├─ is_delete	string	非必须
├─ created_at	string	非必须
├─ updated_at	string	非必须
├─ deleted_at	string	非必须
├─ select	object []	非必须		下拉框	item 类型: object
├─ id	string	必须
├─ mall_id	string	必须
├─ type	string	必须
├─ name	string	必须
├─ setting	string	必须
├─ is_delete	string	必须
├─ created_at	string	必须
├─ updated_at	string	必须
├─ deleted_at	string	必须

打印设置提交

基本信息

Path： /printer/setting-edit

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
printer_id	text	是	1	打印机id
is_attr	text	是	1	是否使用规格
block_id	text	否	1	模板id
type	text	是	{"order":"1","pay":"1","confirm":"1"}	打印配置order:下单 pay付款 confirm 确认收货打印
status	text	是	0	是否启用

返回数据

名称	类型	是否必须	默认值	备注	其他信息

打印设置删除

基本信息

Path： /printer/setting-destroy

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	示例	备注
id	text	是	1	打印设置id